Online Debit API Fields

0001 (Transaction Type)

  • Description: REQUIRED IN all input API files.
    • Ex.: 0001,02
  • Determines what action Fusebox will perform with the data presented in the API input file.
  • Length: 2
  • Data Type: numeric

0002 (Transaction Amount)

  • Description: 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.
  • Length: 4-8
  • Data Type: cents

0003 (Account Number)

  • Description: 128 A/N on Input, 22 A/N on response. 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:################### with 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.
  • Length: 128, 22
  • Data Type: alphanumeric

0006 (Auth Code)

  • Description: Code returned from the card issuer or authorizing institution indicating an approval. Valid Authorization Codes include ’ ’ (space)
  • Length: 6
  • Data Type: alphanumeric

0007 (Reference Number)

  • Description: Unique number supplied by the POS to identify the transaction within a batch/processing period. This number must be unique within a settlement batch.
  • Length: 1-8
  • Data Type: numeric

0009 (Batch Number)

  • Description: Incrementing number that identifies the batch number. A batch number may not be available under some processor specifications. In this situation, Fusebox keeps an internal number and presents it in every output file.
  • Length: 1-8
  • Data Type: numeric

0017 (Cash Back)

  • Description: Conditional. Amount of cash back included in the amount API Field 0002. Required for SVS virtual cards only.
  • Length: 4-9
  • Data Type: numeric

0018 (Debit PIN Block)

  • Field Name: Debit PIN Block
  • Description: Conditional. Value = 1234. Required for SVS virtual cards only.
  • Length: 16
  • Data Type: alphanumeric

0019 (Key Serial Number)

  • Description: Check value used to verify PIN block encryption during DUKPT debit processing. Refer to your TPP for any special considerations.
  • Length: 1 - 20
  • Data Type: alphanumeric

0020 (Surcharge Amount)

  • Description: Any additional amount included in the Total Amount (Field 002) is added as a debit processing charge (ATM fee). Refer to your TPP for any special considerations.
  • Length: 4-8
  • Data Type: cents

0021 (Network ID)

  • Description: Identifies debit network issuing authorization. Refer to your TPP for any special considerations.
  • Length: 1-20
  • Data Type: alphanumeric

0022 (Debit Authentication Code)

  • Description: Used during debit transactions occurring outside U.S. (NDC). Used to verify debit network access. Refer to your TPP for any special considerations.
  • Length: 1-10
  • Data Type: alphanumeric

0023 (Debit Account Type)

  • Description: Type of debit account used.
  • Value Types include:
    • 00=Checking (default)
    • 01=Savings
    • 02=Other
    • Refer to your TPP for any special considerations.
  • Length: 2
  • Data Type: numeric

0025 (Business Date)

  • Description: 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.
  • Length: 6
  • Data Type: numeric

0032 (Original Auth Date)

  • Description: Date the original authorization transaction took place. Format: MMDDYY
  • Length: 6
  • Data Type: date

0033 (Original AuthTime)

  • Field Name:
  • Description: Time the original authorization transaction took place. Format: HHMMSS
  • Length: 6
  • Type: time

0034 (Authorization Characteristics Indicator)

  • Description: Code that is used to track participation status of this transaction in interchange rate programs.
  • Length: 1
  • Data Type: alphanumeric

0037 (Validation Code)

  • Description: Computed value assigned by the card association (Visa, MasterCard, etc.) and used to verify data integrity between authorization and settlement.
  • Length: 1
  • Data Type: alphanumeric

0038 (Reason Code)

  • Description: Code assigned by some third-party processors to track why a transaction was rated as it was.
  • Length: 1-2
  • Data Type: alphanumeric

0040 (Compliance Data)

  • Description: 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.
  • Length: 1
  • Data Type: alphanumeric

0042 (Compliance Data)

  • Description: Code assigned by the credit card issuing bank to the transaction.
  • Length: 1-6
  • Data Type: alphanumeric

0043 (System Trace Audit Number)

  • Description: 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.
  • Length: 6
  • Data Type: numeric

0105 (Data Files Path)

  • Description: Contains the directory path where Fusebox is installed on the system.
  • Length: 1 - 28
  • Data Type: alphanumeric

0106 (Batch File Path)

  • Description: Directory path and filename where the Fusebox settlement file is located.
  • Length: 1-26
  • Data Type: alphanumeric

0107 (Report File Path)

  • Description: Contains the directory path and filename for the Fusebox settlement report.
  • Length: 1-80
  • Data Type: alphanumeric

0108 (History File Path)

  • Description: Contains the directory path to where history files are to be archived.
  • Length: 1-80
  • Data Type: alphanumeric

0109 (Terminal ID)

  • Description: 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.
  • Length: 1-8
  • Data Type: alphanumeric

0110 (Cashier ID)

  • Description: Can contain any code or name up to seven characters to identify the person running the POS.
  • Length: 1-8
  • Data Type: alphanumeric

0115 (Transaction Qualifier)

  • Description: 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.
  • Length: 3
  • Data Type: numeric

0125 (Compliance Data)

  • Description: Assigned for chargeback retrieval purposes. May be required on receipt.
  • Length: 1 - 15
  • Data Type: alphanumeric

0126 (Compliance Data)

  • Description: Indicator showing how card was presented on original authorization.
  • Valid Values are:
    • 0 = Manual
    • 01 = track1
    • 02 = track2.
      • This value can be stored optionally in the POS application to inform the user how the original transaction was presented, Manual or Swiped (track 1 or track 2).
  • Length: 1
  • Data Type: numeric

0127 (Compliance Data)

  • Description: Any additional, non‐standard data the processor requires to be tracked for CPS compliance.
  • Length: 1
  • Data Type: alphanumeric

0128 (CPS Original Authorization Amount)

  • Description: Requested Amount (0.00-99999.99).
  • Length: 4-8
  • Data Type: cents

0130 (CPS Total Authorized Amount)

  • Description: Approved Amount (0.00 – 99999.99).
  • Length: 4-8
  • Data Type: cents

0131 (CPS Total Incremental Auths Sent)

  • Description: This is the total number of incremental authorizations that were sent within a batch settlement.
  • Length: 2
  • Data Type: numeric

1000 (Card Type)

  • Description: Two‐character card abbreviation defined in pbconfig.cfg.
  • Length: 2
  • Data Type: alphanumeric

1001 (Card Name)

  • Description: 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.
  • Length: 1-26
  • Data Type: alphanumeric

1003 (Fusebox Response Code)

  • Description: Code generated by 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.
  • Length: 1-4
  • Data Type: numeric

1004 (Host Response Message)

  • Description: Host response message, either verbatim or evaluated. May contain a Fusebox error message.
  • Length: 1 - 80
  • Data Type: alphanumeric

1005 (Merchant Number)

  • Description: Merchant number from the merchant file. Must be printed on receipt.
  • Length: 1-30
  • Data Type: alphanumeric

1009 (Host Response Code)

  • Description: Host response code indicating the condition of the transaction (both authorization and settlement).
  • Length: 1-10
  • Data Type: alphanumeric

1010 (Fusebox Response)

  • Description: Fusebox response message corresponding to the error code returned in API Field 1003.
  • Length: 1-80
  • Data Type: alphanumeric

1011 (Host Reference Number)

  • Description: 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.
  • Length: 1-8
  • Data Type: alphanumeric

2010 (Total Debit Card Sales Count)

  • Description: Total net debit card sale transaction count. (Sales ‐ Void Sales).
  • Length: 4
  • Data Type: numeric

2011 (Total Debit Card Sales Amount)

  • Description: Net total debit card sale transaction amount. (Sales ‐ Void Sales).
  • Length: 12
  • Data Type: cents

2014 (Total Debit Card Void Count)

  • Description: Net total debit card void count.
  • Length: 4
  • Data Type: numeric

2015 (Total Debit Card Void Amount)

  • Description: Net total debit card void amount.
  • Length: 12
  • Type: cents

2018 (Total Debit Card Return Count)

  • Description: Net total debit card return count.
  • Length: 4
  • Data Type: numeric

2019 (Total Debit Card Return Amount)

  • Description: Net total debit card return amount.
  • Length: 4
  • Data Type: cents