API Fields

0017 (Cash Back)

  • Description: Contains the amount of any advance included in the purchase field (field 2).
  • Valid Values: Only valid range is: 0.00 - 999.99 ($999.99 Max).
    • Supports Cash Benefit (0119 = 040) transactions
    • Does Not support Food Stamp transactions (0119 = 010) or Voids or Returns
  • Length: 4-6
  • Data Type: cents

0073 (Tax 2 Indicator)

  • Description: Indicates whether Tax Amount 2 (Field 74) is included in the total price.
  • Valid Values:
    • 1 = Yes
    • 2 = Exempt
  • Length: 1
  • Data Type: numeric

0074 (Tax 2 Amount)

  • Description: Contains the amount of additional taxes.
  • Length: 4-7
  • Data Type: cents

0075 (Tax 3 Indicator)

  • Description: Indicates whether Tax Amount 3 (Field 76) is included in the total price.
    • 1 = Yes
    • 2 = Exempt
  • Length: 1
  • Data Type: numeric

0076 (Tax 3 Amount)

  • Description: Contains the amount of additional taxes.
  • Length: 4-7
  • Data Type: cents

0077 (Tax 4 Indicator)

  • Descripton: Indicates whether Tax Amount 4 (Field 78) is included in the total price.
    1 = Yes
    2 = Exempt
  • Length: 1
  • Data Type: numeric

0078 (Tax 4 Amount)

  • Description: Contains the amount of additional taxes.
  • Length: 4-7
  • Data Type: cents

0081 (Tax 2 Type)

  • Description: Indicates the Type of Tax for the Amount provided in Field 74
  • Valid Values:
    • ST = State Sales Tax
    • MT = Municipal Tax
    • RR = Reduced Rate Tax
  • Length: 2
  • Data Type: alphanumeric

0083 (Tax 3 Type)

  • Description: Indicates the Type of Tax for the Amount provided in Field 76
  • Valid Values: Use a valid value from Tax Type 2 list of options
  • Length: 2
  • Data Type: alphanumeric

0085 (Tax 4 Type)

  • Description: Indicates the Type of Tax for the Amount provided in Field 78.
  • Valid Values: Use a valid value from Tax Type 2 list of options
  • Length: 2
  • Data Type: alphanumeric

0086 (Tax 4 Rate)

  • Description: Tax 4 rate applied to this transaction that is usually a percentage expressed in decimal format.
  • Length: 1-10
  • Data Type: numeric

0115 (Transaction Qualifier)

  • Description: Indicates the Type of Tax used for transactions.
    • 010=Credit
    • 030=Debit
    • 040=EBT
    • 085=Cash
  • Length: 3
  • Data Type: numeric

0119 (EBT Qualifier)

  • Description:
  • Valid Values:
    • 010=Food Stamps
    • 040=Cash Benefit
  • Length: 3
  • Data Type: numeric

1060 (Voucher Number)

  • Description: Conditional, but Mandatory for a Voucher Clear Transaction
  • Length: 1-25
  • Date Type: alphanumeric

1061 (Number of Accounts)

  • Description: Identifies number of response accounts with balance information returned by TPP
  • Length: 2
  • Data Type: numeric

1062 (Account 1 Balance Details)

  • Description: Response Tableized Data - Semi-colon (;) delimited field used to hold account balance information returned by TPP. Data returned may differ by TPP.
  • Valid Values:
    • * Account Type
      • Savings Account=10
      • Checking Account=20
      • Load (Prepaid)=28
      • Credit Card Account=30
      • Universal Account=40
      • Spending Power=64
      • Activate (Prepaid)=72
      • Cash Benefit=96
      • Food Stamp=98
    • * Amount Type 2N depends on Account Type value. See field 1064 for description.
    • * Currency Type 3-4N (0840 - US Dollars 3-digit code defines the currency used in the amount)
    • * Sign Amount:
      • 1 AN
      • C or 0 - Positive Amount
      • D - Negative Amount
    • * Balance Amt - 12N
      • Balance amount will include decimal, Ex. 32.45.
  • Length: 2
  • Data Type: not specified

1063 (Account 2 Balance Details)

  • Description: See Options/Description Field 1062.
  • Valid Values: Amount Type options from 1062
    • EBT 01 Ending Balance
      • 02 - Available Balance
      • 18 - Beginning Balance
      • 40 - Amount Cash
      • 57 - Preauthorized Amount
    • Non-EBT
      • 00 - Load or Activate (Prepaid card balance)
      • 01 - Deposit Accounts (Current ledger balance)
      • Credit Card Accounts (Open-to-buy)
      • 02 - Deposit Accounts (Current available balance)
      • Credit Card Accounts (Customer’s credit limit)
      • Spending Power Accts (Current remaining preauthorization amt)
      • 57 - Not Specified (Total transaction amt of the original request)
  • Length: 0-255
  • Data Type: alphanumeric