Check API Fields

API Field #Field NameSizeTypeOption/DescriptionInOut*Store
0001Transaction Type2NElectronic Check Conversion/Verification/Guarantee = 02

Void = 11
0002Transaction Amount1-14CTotal amount of the transaction, using currency mask 0.00.
0003Account Number1-254A/NAccount number is not required for check, but a masked account number will be returned for reference. Check transactions do not support Tokenization.
0006Authorization Code6A/NApproval code.
0007Reference Number1-8NUnique reference number to transaction.

important

Elavon does not recommend padding the Reference Number field (Field 0007) with leading zeros. Should you choose to do so, be sure to store the value in your system as a String instead of an Integer. This will eliminate any potential discrepancies in how this field is presented in two-part transactions, and the chance of downgrades or fees is greatly reduced.

0009Batch Number1-8NCurrent open batch number at host.
0030Online Indicator1NCode returned by the Elavon Gateway Applications indicating the transaction was processed online. This value must be returned with any subsequent adjustments or capture requests.

0 = Offline

1 = Online
0033Authorization Transaction Time6TTime of the original transaction (HHMMSS).
0036Transaction Identifier1-15A/NUnique tracking number assigned to the transaction by the TPP.
0037Authorizer1A/NCode which identifies the authorizing agency .
0043System Trace Audit Number25NThe STAN is a unique number generated by Third Party Processor Interface and used by the processor to track a transaction through its system.
0054POS Entry Mode2NISO POS entry mode values:
01-Manual/Key Entry
10-MICR Entry
0060Unique Device ID8NThe data in this field identifies the source lane or terminal through which a transaction is processed, so that a compromised device or fraudulent transaction can be easily identified.

Some third-party processors only support a maximum of four digits being passed in this field, so the last four numbers must be unique to each register within a location. This field should be presented in all transaction types supported by a POS/PMS application.
0109Terminal8A/NTerminal passed in the incoming message.
0110Cashier ID1-8A/NCan contain any code or name up to 8 uppercase characters to identify the person logged into the POS.
0112Processor ID3NResponds with the Third Party Processor Interface number used to process this transaction
0115Transaction Qualifier3NFusebox Conversion – 020.
0125Retrieval Reference Number1-15A/NAssigned for chargeback retrieval purposes.
0126Track Indicator1NIndicator showing how card was presented on original authorization:

0=Manual

1= MICR swiped
0130Total Authorized Amount1-14CTotal amount authorized.
0140Merchant Currency Trigraph3AISO Alpha Currency Code of the merchant.
0651Auxiliary TPP Reversal Data256A/NSome TPPs require special data to be retained from the original request and return with future transactions live a void.

note

This value does not have to be stored or retained.

0900Account Number/MICR1-40A/NMICR information to be sent to processor.

May be manual account number (up to 15 characters) or swiped data that includes the all the information from the bottom of the check.

note

Output is masked in the response.

0901Driver’s License1-127A/NDriver’s license information. May be manually entered or swiped. *Optional.✓*
0902Check Number10NSequential check number of check presented .
0903State ID2AState code where check or driver’s license issued.
0904State Code2NNumeric state code where check or driver’s license was issued. *Optional.✓*
0905Date of Birth6NDate of Birth. The format is MMDDYY.

*Optional.
✓*
0906Check Type3NType of check presented.

000 = personal check (default)

001 = personal savings

003 = corporate

004 = payroll

005 = government
0907MICR Entry Mode1NIndicates how MICR Field 900 was entered:

0 = manual

1 = MICR reader
0908Driver License Entry Mode1NIndicates how Field 901 was entered:

0 = manual

1 = swiped

note

Confirm Federal, State and local regulations regarding the use of a Driver’s License.


Optional.
0910Zip Code9A/NZip Code from address listed on check presented.

*Optional.
✓*
0911Phone Number10NPhone number of primary account holder listed on check. *Optional.✓*
0912ABA Number9NABA (transit) number from the bottom of the check.

Required for manually entered account numbers.

✓*
0913Alternate Identification Indicator1NIndicator that identifies the type of alternate identification presented:

0 = Other

1 = SSN

2 = Courtesy Card

3 = Military ID

4 = Debit Card

5 = Credit Card

6 = Address

* Optional

note

Confirm Federal, State and local regulations regarding the use of alternate identification

✓*
0914Alternate Identification80A/NAlternate Identification. This field contains the appropriate data relating to the type of identification noted in field 913.

Should be Masked in the response. *Optional.
✓*
0916Check Status1A/N0=Verification Only

1=Accept Check Conversion

2=Decline Check Conversion

4=Validation

5=Guarantee
0917ACH Reference Number1-25A/NHost Reference for approved ACH transactions.
0918Returned Check Note1-100A/NTo accommodate additional state specific return check fee information.
0920ACH Check Format Code3NThe format code required for ACH ECS transactions
Valid Values:
001 = ECS Data - Format B
0921ACH Check Product Code3A/NIndicates the ECS Product method used for the ACH transaction.
Valid Values:
WEB = Web Initiated-Entry
TEL = Telephone Initiated-Entry
CCD = Corporate Cash Disbursement
PPD = Pre-Arranged Payment and Deposit
0934Check Consumer Name25ANThis field contains the Name of the Consumer making the check transaction
Field may also contain an Opt Out Number
No Special Characters Allowed
1000Card Type2A/NCK – Fusebox Electronic Check Conversion.
1001Card Name1-26A/NCHECK – Fusebox Electronic Check Conversion.
1003Elavon Response Code1-4NCode generated by the Elavon Gateway Applications to indicate the status of the transaction.
1004Host Response Message1-80A/NHost response message, either verbatim or evaluated. May contain Elavon Gateway messages.
1005Merchant Number1-30A/NMerchant number from the merchant information configured the Fusebox site ID.
1008Masked Account Number21A/NMasked Account Number (last 4 preserved).

note

Fusebox does not support Tokenization 1008, ID: on check transactions).

1009Host Response Code1-10A/NHost response code indicating condition of the transaction.
1010Elavon Response Message1-80A/NElavon verbose response message corresponding to error code returned in field 1003.
1012Elavon Batch Number1-8NElavon batch number assigned to this transaction.

note

The actual fields returned in the Output Response are dependent on the module being used. If the interface requires the data, and the processor returns the information, it is returned in the format required by the processor.