ACHRecurringDebitInsert
Description: This method creates a recurring ACH debit transaction rule.
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 account holder. |
BillingCity |
No | String | 50 | The billing city of the account holder. |
BillingCountry |
No | String | 50 | The billing country of the account holder. |
BillingFullName |
No | String | 50 | The name of the account holder as it appears on the account. |
BillingNameFirst |
No | String | 50 | The first name of the account holder. |
BillingNameLast |
No | String | 50 | The last name of the account holder. |
BillingPhone |
No | Number | 10 | The phone number of the account holder. |
BillingState |
No | String | 25 | The billing state of the account holder. |
BillingZipCode |
No | String | 10 | The billing zip code of the account holder. |
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 account holder data to be able to perform an ACH Credit transaction. |
Custominfo1 (1-20) |
No | String | 255 | For merchant use. |
DayOfMonthOption |
Yes | Number | 1 | 0=None, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 |
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 account holder. |
EndDate |
No | Number | 8 | End date for recurring payment. Format MMddyyyy. Leave blank if there is no end date. |
MerchantID |
Yes | Number | 9 | The identification that is assigned to the merchant. |
MerchantKey |
Yes | String | 36 | A unique identification that is assigned to the merchant id. |
MonthlyOption |
Yes | Number | 1 | 0=None, 1= Set day of month option (MonthOfYearOption and DayOfMonthOption are required), 2= Set the advanced option per month (WeekOption, WeekdayOption, and MonthofYearOption are required) |
MonthOfYearOption |
No | Number | 1 | 0=None, 1=One, 2=Two, 3=Three, 4=Four, 5=Five, 6=Six, 7=Seven, 8=Eight, 9=Nine, 10=Ten, 11=Eleven, 12=Twelve Only applicable when MonthlyOption=2 |
OccurenceOption |
Yes | Number | 1 | 1=Daily, 2=Monthly |
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 the transaction. |
StartDate |
Yes | Number | 8 | Start date for recurring payment. Format MMddyyyy. |
Token |
No | String | 36 | KORT Payments Token |
TransactionType |
Yes | String | 25 | ACHRecurringDebitInsert |
TransID |
No | Number | 10 | Transaction ID assigned by KORT Payments from a historical transaction. |
WeekdayOption |
No | Number | 1 | 0=None, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday Only applicable when MonthlyOption=2 |
WeekOption |
No | Number | 1 | 0=None, 1=First, 2=Second, 3=Third, 4=Fourth, 5=Last week of the month. Only applicable when MonthlyOption=2 |
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. |
