HSA Card API Fields

API field formats for 1074 to 1083

1074 (Request Account 1 Details)

  • Description: Request 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
      • Length: 2
      • Field Type: N (00 – Not specified)
    • Amount Type
      • Length: 2
      • Field Type: Field Type N
        • 4S = Medical
        • 4U = RX
        • 4V = Vision/Optical
        • 4W = Clinic/Other Med
        • 4X = Dental
        • 4T = Transit
        • 40 = Cash
        • 02 = Deposit Accounts/Credit Card
        • Accounts/Spending Power Accounts
        • 57 = Not Specified
    • Currency Type
      • Length: 3
      • Field Type: N
    • Sign Amount
      • Field Length: 1
      • Field Type: AN
    • Balance Amount
      • Field Length: 12
      • Field Type Numeric (N) (will include decimal)
  • Length: 255
  • Data Type: alphanumeric

1075 (Request Account 2 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1076 (Request Account 3 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1077 (Request Account 4 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1078 (Request Account 5 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1079 (Request Account 6 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1080 (Request Account 7 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1081 (Request Account 8 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1082 (Request Account 9 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

1083 (Request Account 10 Details)

  • Description: See Options/Description Field 1074
  • Length: 0-255
  • Data Type: alphanumeric

Transit Expenses

Transit amount type would be for an ambulance or medical transit to a hospital, medical facility or doctor’s office.

note

This type of expense will never be on the same transaction as other medical expenses and will be a stand-alone entry utilizing only API Field 1074.

Transit Scenario Ambulance or Medical

  • Field(s): Transit Expense
  • Example: 1 Field: 1074,00;4T;840;C;100.00

Medical Expenses

  • Medical expenses are handled as a combination with a rolled up amount of general medical expenses. This is handled by a total for medical expenses in API Field 1074 followed by fields with the subtotal amounts.

note

It there is a medical expense that does not fit one of the categories identified, the sub-amount in API Field 1074 may be greater than the total of all of the defined entries.

Medical Scenarios

Medical Scenario

  • Visit pharmacy and purchase 1 or more prescriptions. Total was $49.95 for total of all prescriptions.
    • Field(s): 2 fields
    • Example:
      • 1074,00;4S;840;C;49.95
      • 1075,00;4U;840;C;49.95

Medical Scenario

  • Visit to pharmacy with visit to clinic for $50.00 charge and prescription charge for $37.10 with a total $87.10.
    • Field(s): 3 fields
    • Example:
      • 1074,00;4S;840;C;87.10
      • 1075,00;4U;840;C;37.10
      • 1076,00;4W;840;C;50.00

Medical Scenario

  • Visit to pharmacy with charge for a medical expense not mapped to one of the valid values for $20.00 and have a prescription charge for $37.10 for a total of $57.10.
  • Field(s): 2 fields
  • Example:
    • 1074,00;4S;840;C;57.10
    • 1075,00;4U;840;C;37.10

Medical Scenario

  • Visit to pharmacy/medical facility with a generic expense that does not map to one of the valid values for a total of $35.25.
    • Field(s): 1 field
    • Example: 1074,00;4S;840;C;35.25