On This Page
Fields for an ACH Service Debit Request
This table describes the required and optional fields for specifying
an ACH service debit request.
Field names are listed in the table as they appear in batch file templates.
An asterisk after a field name indicates that the field is required for an authorization request.
When you create a batch file based on a template, remove any asterisks from field names.
Column | Field Name | Description | Required? | Data Type | Length |
|---|---|---|---|---|---|
A | merchantReferenceCode * | Merchant-generated order reference or tracking number. | Required | String | 50 |
B | purchaseTotals_currency* | Currency used for the order. | Required | String | 5 |
C | purchaseTotals_grandTotalAmount* | Grand total for the order.
You must include either this field or item_#_unitPrice in your request.
If you use TSYS Acquiring Solutions as your payment processor,
you can set this field to 0 to check whether the card is lost or stolen. | Required | String | 15 |
D | billTo_firstName* | Customer’s first name. The value should be the same as the one that appears on the card. | Required | String | 60 |
E | billTo_lastName* | Customer’s last name. The value should be the same as the one that appears on the card. | Required | String | 60 |
F | billTo_customerID | Your identifier for the customer. | Optional | String | 50 |
G | billTo_email* | Customer’s email address, including the full domain name. For example: jdoe@example.com | Required | String | 255 |
H | billTo_street1* | First line of the billing street address. | Required | String | 60 |
I | billTo_street2 | Second line of the billing street address. Used for additional address information. For example: Attention: Accounts Payable | Required | String | 60 |
J | billTo_city* | City of the billing address. | Required | String | 50 |
K | billTo_state* | State or province of the billing address. Use the two-character codes. | Required | String | 2 |
L | billTo_country* | Country of the billing address. Use the two-character ISO codes. | Required | String | 2 |
M | billTo_postalCode* | Postal code for the billing address. The postal code must consist of 5 to 9 digits. For a 9-digit postal code, use this format:
| Required | String | 10 |
N | check_accountType* | Checking account type. See Request Fields for possible values. | Required | NA | NA |
O | check_bankTransitNumber* | Bank routing number (or "transit number"). | Required | NA | NA |
P | check_accountNumber* | Checking account number. If processing encoded account numbers, use this field for the encoded account number. | Required | NA | NA |
Q | check_checkNumber | Check number. NOTE: If you use AmeriNet, check with them to see if they require you to provide this field. | Optional | NA | NA |
R | billTo_phoneNumber | Customer’s phone number. | Optional | String | 15 |
S | billTo_driversLicenseNumber | Driver’s license number of the customer. Required for AmeriNet guaranteed personal checking. For TeleCheck , see description of billTo_company. | Optional | NA | NA |
T | billTo_driversLicenseState | State or province where the customer’s driver’s license was issued. Required for AmeriNet guaranteed personal checking. For TeleCheck , see description of billTo_company. | Optional | NA | NA |
U | billTo_company | Name of the customer’s company. Required for AmeriNet guaranteed corporate checking. For TeleCheck personal checks, you must provide billTo_driversLicenseNumber and billTo_driversLicenseState. For TeleCheck corporate checks, you must provide either both billTo_driversLicenseNumber and billTo_driversLicenseState, or both billTo_company and billTo_companyTaxID. | Optional | NA | NA |
V | billTo_companyTaxID | Tax identifier of the customer’s company. For TeleCheck , see description of billTo_company. | Optional | NA | NA |
W | billTo_dateOfBirth | Customer’s date of birth. NOTE: If you use AmeriNet, check with them to see if they require you to provide this field. For AmeriNet corporate accounts, use the value 1970-01-01. | Optional | NA | NA |
X | billTo_ipAddress | IP address for the customer. Example: 10.1.27.63. | Optional | String | 15 |
Y | check_secCode | Code that specifies the authorization method for the transaction. | Optional | String | 3 |