Online Debit API Fields
| Field | Name | Length Type |
Description |
|---|---|---|---|
| 0001 | Transaction Type | 2 numeric |
REQUIRED. Must be included in all input API files. Determines what action Fusebox will perform with the data presented in the API input file. Ex.: 0001,02 |
| 0002 | Transaction Amount | 4 - 8 cents |
Total amount for the transaction including tax and gratuity. Minimum of four characters, decimal point included (i.e., 1.00). Maximum amount including decimal is 99999.99 for any transaction. |
| 0003 | Account Number | 128, 22 alphanumeric |
128 A/N on Input, 22 A/N on response and all transactions past the initial Input Request. Contains either the unformatted track swipe or the manually‐entered account number on the first input request. If magnetically read, the swipe data should be unaltered as read by the swipe. Output responses and future input requests reference the transaction with the Token. The format for API Field 0003 Token is: ID:################### No spaces in the entire field for a total length of 22. It is against card association regulations to store track data. The Token is returned in API Field 0003. The POS application will store the Token and pass this value on all successive transactions until the transaction has been successfully settled. If using Simplify, this field can be left blank and the Account Number will be input by the terminal device. |
| 0006 | Auth Code | 6 alphanumeric |
Code returned from the card issuer or authorizing institution indication an approved. Valid Authorization Codes include ‘ ‘ (space) |
| 0007 | Reference Number | 1-8 numeric |
Unique number supplied by the POS to identify the transaction within a batch/processing period. This number must be unique within a settlement batch. |
| 0009 | Batch Number | 1-8 numeric |
Incrementing number that identifies the batch number. A batch number may not be available under some processor specifications. In this situation, the Fusebox keeps an internal number and presents it in every output file. |
| 0017 | Cash Back | 4‐9 numeric |
Amount of cash back included in the amount API Field 0002. Conditional. Required for SVS virtual cards only. |
| 0018 | Debit PIN Block | 16 alphanumeric |
Value = 1234, Conditional. Required for SVS virtual cards only. |
| 0019 | Key Serial Number | 1-20 alphanumeric |
Check value used to verify PIN block encryption during DUKPT debit processing. Refer to your TPP for any special considerations. |
| 0020 | Surcharge Amount | 4-8 cents |
Any additional amount included in the Total Amount (Field 002) added as a debit processing charge (ATM fees). Refer to your TPP for any special considerations. |
| 0021 | Network ID | 1-20 alphanumeric |
Identifies debit network issuing authorization. Refer to your TPP for any special considerations. |
| 0022 | Debit Authentication Code | 1-10 alphanumeric |
Used during debit transactions occurring outside U.S. (NDC). Used to verify debit network access. Refer to your TPP for any special considerations. |
| 0023 | Debit Account Type | 2 numeric |
Type of debit account used. 00=Checking (default) 01=Savings 02=Other. Refer to your TPP for any special considerations. |
| 0025 | Business Date | 6 numeric |
Used to control business date in Fusebox. For POS applications that process transactions where the end of day may cross over dates, this field can be used to keep one day’s business as defined by the POS Application consistent. |
| 0032 | Original Auth Date | 6 date |
Date the original authorization transaction took place. Format: MMDDYY |
| 0033 | Original AuthTime | 6 time |
Time the original authorization transaction took place. Format: HHMMSS |
| 0034 | Authorization Characteristics Indicator | 1 alphanumeric |
Code that is used to track participation status of this transaction in interchange rate programs. |
| 0037 | Validation Code | 1 alphanumeric |
Computed value assigned by the card association (Visa, MasterCard, etc) and used to verify data integrity between authorization and settlement. |
| 0038 | Reason Code | 1‐2 alphanumeric |
Code assigned by some third party processors to track why a transaction was rated as it was. |
| 0040 | Compliance Data | 1 alphanumeric |
Contains the indicator returned by issuing bank to indicate the result of the CVV2 (Visa), CVC2 (MasterCard) or CID (Amex) verification. See the CVV2/CVC2/CID section for more information. May be used by the POS application or cashier to evaluate the risk associated with a manually keyed transaction. |
| 0042 | Compliance Data | 1-6 alphanumeric |
Code assigned by the credit card issuing bank to the transaction. |
| 0043 | System Trace Audit Number | 6 numeric |
The System Trace Audit Number (STAN) is a unique number generated and used by the processor to track a transaction through its system. It is often the “key” field used by the processor to lookup a previous transaction when a Time Out Reversal is requested. Many Gift Card and Debit processors require the STAN to be printed on the receipt. If in Output Response, may be required to print on receipts. |
| 0105 | Data Files Path | 1-28 alphanumeric |
Contains the directory path where Fusebox is installed on the system. |
| 0106 | Batch File Path | 1-26 alphanumeric |
Directory path and file name where the Fusebox settlement file is located. |
| 0107 | Report File Path | 1-80 alphanumeric |
Contains the directory path and file name for the Fusebox settlement report. |
| 0108 | History File Path | 1-80 alphanumeric |
Contains the directory path to where history files are to be archived. |
| 0109 | Terminal ID | 1-8 alphanumeric |
References a terminal defined in PbConfig.cfg that lets Fusebox know which processor to dial, what phone # to use, and which merchant information to access. In Fusebox, a single terminal can be used to process multiple methods of payment and MKey definitions. |
| 0110 | Cashier ID | 1-8 alphanumeric |
Can contain any code or name up to 7 characters to identify the person running the POS. |
| 0115 | Transaction Qualifier | 3 numeric |
Determines type of account used. 030=Debit All transactions must pass a transaction qualifier. The Transaction Qualifier must correspond to the Transaction Qualifier identified in the Fusebox Configuration, Card Types. This field may be left blank and the Transaction Qualifier input by the peripheral device for the Method of Payment selected by the cardholder. |
| 0125 | Compliance Data | 1-15 alphanumeric |
Assigned for chargeback retrieval purposes May be required on receipt. |
| 0126 | Compliance Data | 1 numeric |
Indicator showing how card was presented on original authorization: 00=Manual, 01=track1 02 = track2 This value can optionally be stored in the POS application to provide to the user how the original transaction was presented (Manual, or Swiped (track 1 or 2). |
| 0127 | Compliance Data | 1 alphanumeric |
Any additional, non‐standard data the processor requires to be tracked for CPS compliance. |
| 0128 | CPS Original Authorization Amount | 4-8 cents |
Requested Amount (0.00 – 99999.99) |
| 0130 | CPS Total Authorized Amount | 4-8 cents |
Approved Amount (0.00 – 99999.99) |
| 0131 | CPS Total Incremental Auths Sent | 2 numeric |
This is the total number of incremental auths that were sent within a batch settlement. |
| 1000 | Card Type | 2 alphanumeric |
Two‐character card abbreviation defined in pbconfig.cfg |
| 1001 | Card Name | 1-26 alphanumeric |
Full card name defined in pbconfig.cfg. May be printed on receipts (either API Field 1000 or 1001 must be printed on receipts). May be associated to the Token to allow the POS application to know what type of payment is associated with the transaction. |
| 1003 | Fusebox Response Code | 1-4 numeric |
Code generated by the Fusebox to indicate its state when exiting. Governs internal error messages parsed from pberrors.txt and displayed in API Field 1010 and/or host messages displayed in API Field 1004. See General Information for Reviewing Response Fields. |
| 1004 | Host Response Message | 1-80 alphanumeric |
Host response message, either verbatim or evaluated. May contain a Fusebox error message. |
| 1005 | Merchant Number | 1-30 alphanumeric |
Merchant number from the merchant file. Must be printed on receipt. |
| 1009 | Host Response Code | 1-10 alphanumeric |
Host response code indicating the condition of the transaction (both authorization and settlement). |
| 1010 | Fusebox Response | 1-80 alphanumeric |
Fusebox response message corresponding to the error code returned in API Field 1003. |
| 1011 | Host Reference Number | 1-8 alphanumeric |
Reference number assigned by the host processor to track this transaction. This is both an input AND output field. If returned in the Output Response, it must be printed on the receipt. |
| 2010 | Total Debit Card Sales Count | 4 numeric |
Total net debit card sale transaction count. (Sales ‐ Void Sales). |
| 2011 | Total Debit Card Sales Amount | 12 cents |
Net total debit card sale transaction amount. (Sales ‐ Void Sales). |
| 2014 | Total Debit Card Void Count | 4 numeric |
Net total debit card void count. |
| 2015 | Total Debit Card Void Amount | 12 cents |
Net total debit card void amount. |
| 2018 | Total Debit Card Return Count | 4 numeric |
Net total debit card return count. |
| 2019 | Total Debit Card Return Amount | 4 cents |
Net total debit card return amount. |