Default header format
When creating the batch file, the file must contain a header and must be in a tab-delimited format.
The header must be formatted in this fashion:
!BATCH [tab] card-amount [tab] card-name [tab] card-address1 [tab] card-address2 [tab] card-city [tab] card-state [tab] card-zip [tab]card-country [tab] card-number [tab] card-exp [tab] email
Please Note:
-
The header line must be the first line in the file.
-
The “!” is required in the header line.
-
All fields are case sensitive in the header line.
Variable | Description | Max Size |
!BATCH | This is the type of transaction that will be performed on this merchant’s credit card.Option are:auth - For authorizationcredit - For new returnreturn - For return against previous orderIDmark - Mark a transaction for settlementvoid - Void a transaction before it settlesreauth - Reauthorize a transaction for a lower amountforceauth - Force authorization using auth codebill_member - Bill a membership management member | |
card-amount | This is the total dollar amount of the authorization or return.(Do not use a “$”) | 8 |
card-name | This is the name that appears on the customer’s credit card statement. | 39 |
card-address1 | This is the address on the customer’s credit card statement (Line 1) | 39 |
card-address2 | This is the address on the customer’s credit card statement (Line 2) | 39 |
card-city | This is the city on the customer’s credit card statement | 39 |
card-state | This is the state on the customer’s credit card statementThis should be in 2-letter abbreviation - Example: For New York use ‘NY’Please see Appendix for complete list of state codes. | 2 |
card-zip | This is the zip code on the customer’s credit card statement | 11 |
card-country | This is the country on the customer’s credit card statement (Line 1) This must be in 2-letter abbreviation - Example: For United States use ‘US’ Please see Appendix for complete list of country codes. | 2 |
card-number | This is the customer’s credit card numberCard number should only contain numbers; no spaces or dashes. | 16 |
card-exp | This is the customer’s credit card expiration date.This must be in a 2 digit month / 2 digit year format(MM/YY). | 5 |
This is an optional field used for the customer’s email address. | 39 | |
paymethod | Required for electronic check transactions. Allowed Value: ‘onlinecheck’ for ACH payments. | |
acttype | Required for electronic check transactions. Allowed Value: ‘checking’ | |
routingnum | ABA Bank Routing Number. Required for Electronic Check Payments. | 9 |
accountnum | Account Number. Required for Electronic Check Payments. | |
checktype | SEC code for checks. Possible values are ‘PPD’, ‘CCD’, ‘WEB’, and ‘TEL’. Required for electronic check payments. | 3 |
authtype | Allowed value: authpostauth - Automatically marks transaction for settlement. Defaults to authonly if absent. | |
More fields can be added to the header line.For a complete listing, please use the form fields for Direct payment.[‘Integration Specifications’ Document] |
Notes:
Example File: Should be Tab Delimited
!BATCH card-amount card-name card-address1 card-zip card-number card-exp email
auth 1.00 cardtest address 11788 4111111111111111 03/03 trash@zydtacd.com
auth 1.00 cardtest address 11788 4111111111111111 03/03 trash@zydtacd.com
Example Results: Will be Tab Delimited
FinalStatus MErrMsg resp-code orderID auth-code avs-code cvv-resp !BATCH card-amount card-name card-address1 card-zip card-number card-exp email
success 00 2002120917550420337 TSTAUT U AUTH 1.00 cardtest address 11788 4111**11 03/03 trash@zydtacd.com
success 00 2002120917550420338 TSTAUT U AUTH 1.00 cardtest address 11788 4111**11 03/03 trash@zydtacd.com