ACHDebit
Description: Use these functions to create new ACH transactions. Below are the parameters for this method.
Resource Url: https://webservice.paymentxp.com/wh/WebHost.aspx
Method: POST
Content-Type: application/x-www-form-urlencoded
Notes
- Parameters in bold are required in the request for example, BillingNameFirst
Request
| Parameter | Is Required | Data Type | Max Length | Description |
|---|---|---|---|---|
AccountName |
Yes | String | 23 | Name on account (Checking or Savings) |
AccountNumber |
Yes | String | 17 | Account Number or DDA |
ACHCheckType |
Yes | Number | 1 | Enter 1 or 2. Note: Value must be an integer 1 = Business to consumer transaction 2 = Business to business transaction |
Amount |
Yes | Number | 8 | Amount of sale |
BankAccountType |
Yes | Number | 1 | Enter 1 or 2. Note: 1 = Checking account 2 = Savings account |
BillingAddress |
No | String | 50 | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity |
No | String | 50 | The billing city of the cardholder. |
BillingCountry |
No | String | 50 | The billing country of the cardholder. |
BillingFullName |
No | String | 50 | The name of the cardholder as it appears on the card. |
BillingNameFirst |
No | String | 50 | The first name of the cardholder. |
BillingNameLast |
No | String | 50 | The last name of the cardholder. |
BillingState |
No | String | 25 | The billing state of the cardholder. |
BillingZipCode |
No | String | 10 | The billing zip code of the cardholder. Used to check for AVS identification |
CheckNumber |
Yes | String | 25 | Pass an empty string if check number does not exist. Note: Required only for RCK transaction type. |
ClerkID |
No | String | 15 | The cashier/clerk who initiated the transaction. |
ClientIPAddress |
No | String | 25 | The IP address of the client device. |
CustomerID |
No | String | 50 | An existing customer record that is used to retrieve cardholder data to be able to perform an ACH Debit transaction. |
Custominfo1 (1-20) |
No | String | 255 | For merchant use. |
Description |
Yes | String | 10 | Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement. |
EmailAddress |
No | String | 50 | The e-mail address of the cardholder. |
MerchantID |
Yes | String | 10 | Unique ID assigned by KORT Payments |
MerchantKey |
Yes | String | 36 | Unique Key assigned by KORT Payments |
| PhoneNumber | No | Number | 10 | The phone number of the cardholder. |
| ProcessDate | Yes | String | 8 | Date to process the transaction Format: MMddyyyy |
| ReferenceNumber | No | String | 50 | Merchant’s unique reference number |
| RoutingNumber | Yes | String | 9 | Routing number or ABA |
| ShippingAddress1 | No | String | 50 | The shipping address for the product(s) purchased in the transaction. |
| ShippingAddress2 | No | String | 50 | The shipping address for the product(s) purchased in the transaction. |
| ShippingCity | No | String | 50 | The shipping city for the product(s) purchased in the transaction. |
| ShippingCountry | No | String | 50 | The shipping country for the product(s) purchased in the transaction. |
| ShippingState | No | String | 25 | The shipping state for the product(s) purchased in the transaction. |
| ShippingZipCode | No | String | 10 | The shipping zip code for the product(s) purchased in thetransaction. |
| TransactionType | Yes | String | 19 | ACHDebit |
Response
| Field Name | Description |
|---|---|
| PostedDate | The date and time the transaction was posted. |
| StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
| TransactionID | The number that identifies the transaction in the KORT Payments system. |
| ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
| TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
| Message | The message from the processor. |
| Status | Status Description |
| CustomerName | The name of the account holder as it appears on the account |
| BillingNameFirst | The first name of the account holder. |
| BillingNameLast | The last name of the account holder. |
| BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
| BillingCity | The billing city of the account holder. |
| BillingState | The billing state of the account holder. |
| BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
| BillingCountry | The billing country of the account holder. |
| BillingPhone | The phone number of the account holder. |
| BillingFax | The fax number of the account holder |
| BillingEmail | An existing customer record |
| CustomerID | An existing customer record. |
| RoutingNumber | Routing number or ABA |
| AccountNumber | Account Number or DDA |
| Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
| TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
| VoidDate | The date and time the transaction was voided. |
| TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
