Skip to main content
Version: v2

IIAS Payments

IIAS (Inventory Information Approval System) Payments refer to transactions made using a healthcare payment card (such as a Flexible Spending Account or Health Savings Account card) at merchants equipped with IIAS. The IIAS system automatically verifies and approves eligible healthcare-related purchases in real-time, ensuring compliance with IRS regulations.

Quick Reference
  • IIAS Payments: Used for healthcare cards (FSA, HSA) at IIAS-enabled merchants.
  • API Endpoints:
    • POST v1/sessions — Initiate a session with IIAS payment details
    • POST v1/payments — Initiate a payment with IIAS payment details
  • API Scopes: user, merchant, merchant-pci
  • Supported Payment Method: CARD
  • Key Fields: paymentDetails.healthcare.iias.qualifiedAmount, qualifiedAmountDetails.prescriptionAmount, visionAmount
  • Error Codes: See Payment Details Object Error Codes

What is an IIAS Payment?

  • IIAS Payments automatically check purchased items against a list of eligible healthcare products and services.
  • Only qualified medical expenses are approved and processed using the healthcare payment card.
  • The system streamlines compliance and reduces manual verification for both merchants and cardholders.

Payment Request with IIAS Details

To initiate an IIAS payment, include the paymentDetails object with the appropriate healthcare and IIAS fields in your API request. Request can be made through either Sessions API or Create Payments API

Sample Request

Sample Payload Including paymentDetails for IIAS Payment Through Sessions
{
"customer" : {
"hsid" : "b0b3c48d-4cf6-404a-a554-e14640a51c5b"
},
"payment" : {
"merchantTransactionId" : "849fb3f7-517d-4a75-ab1f-3367615e9556",
"amount" : 800000,
"paymentDetails" : {
"healthcare" : {
"iias" : {
"qualifiedAmount" : 3000,
"qualifiedAmountDetails" : {
"prescriptionAmount" : 1000
}
},
"visionAmount" : 2000
}
}
}
}
Sample Payload Including paymentDetails for IIAS Payment Through Create Payments API(Merchant Scope)
{
"amount" : 9000,
"authorizeCard" : false,
"paymentMethodId" : "fc854a89-3462-46dc-8ce8-c3235309fb7c",
"paymentDescription" : "Create Payment",
"merchantTransactionId" : "0018d835-7484-4737-a3ce-4ae5e81b3e0c",
"customer" : {
"hsid" : "b0b3c48d-4cf6-404a-a554-e14640a51c5b"
},
"statementDescriptorSuffix" : "Payment",
"metadata" : { },
"agent" : null,
"paymentDetails" : {
"healthcare" : {
"iias" : {
"qualifiedAmount" : 3000,
"qualifiedAmountDetails" : {
"prescriptionAmount" : 1000
}
},
"visionAmount" : 2000
}
}
}
Sample Payload Including paymentDetails for IIAS Payment Through Create Payments API(PCI Scope)
{
"merchantTransactionId": "0018d835-7484-4737-a3ce-4ae5e81b3e0c",
"amount": 300000,
"statementDescriptorSuffix": "IVR PCI",
"paymentDescription": "IVR field validation",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": 20000,
"qualifiedAmountDetails": {
"prescriptionAmount": 1000
}
},
"visionAmount": 2000
}
},
"paymentMethod": {
"type": "CARD",
"vendorPaymentMethodId": "pm_1RdQHGGxiRENHMq7bbDInmAK",
"vendor": "STRIPE",
"savePaymentMethod": true,
"paymentMethodDetails": {
"type": "CARD",
"nameOnCard": "Diksha",
"manufacturerCard": false
},
"default": false,
"nickname": "Test"
},
"customer": {
"hsid": "0018d835-7484-4737-a3ce-4ae5e81b3e0c"
}
}

Payment Response for IIAS Payments

A successful IIAS payment will return the qualified and processed amounts in the response, along with the payment status.

info

Whether the payment is made through the API or the UI, if the payment object contains a valid paymentDetails object, the same details will be returned when the user polls for the payment status.

  • qualifiedAmount: The total amount approved for eligible healthcare items
  • qualifiedAmountDetails.prescriptionAmount: The portion of the qualified amount for prescriptions
  • visionAmount: The portion of the payment for vision-related expenses
  • status: Payment status (e.g., COMPLETED, FAILED)
Sample Payments Response Including paymentDetails for IIAS Payment
{
"data": {
"id": "05f09d31-792e-4617-a172-6f39b4bcd4e3",
"amount": 300000,
"capturedAmount": 300000,
"description": "IVR field validation",
"merchantTransactionId": "3723bdb9-5ef6-4ab5-bfa5-472e91ee91dd",
"merchantId": "b955db5e-aef2-47de-bbb9-c80b9cc16e8f",
"paymentType": "SALE",
"currencyCode": "usd",
"customerId": "2df0c056-5325-44be-a024-05fc35bb7af2",
"status": "COMPLETED",
"vendor": "STRIPE",
"vendorPaymentId": "pi_3RdQI5Bdjib8OdkY0fU4iyNd",
"vendorMerchantId": "acct_1N0KXoBdjib8OdkY",
"statementDescriptorSuffix": "IVR PCI",
"paymentMethodId": "ecb97780-2461-46f1-bc8f-e8f314ca08b0",
"metadata": {
"checkoutId": null,
"merchantId": "b955db5e-aef2-47de-bbb9-c80b9cc16e8f",
"referenceId": "05f09d31-792e-4617-a172-6f39b4bcd4e3",
"merchantName": "ccg-optum-rx",
"ccg_processor": "STRIPE",
"merchantGroupId": "3cf34cba-ffec-48fb-b7ca-09977db1077a",
"ccg_paymentMethodId": "ecb97780-2461-46f1-bc8f-e8f314ca08b0",
"merchantTransactionId": "3723bdb9-5ef6-4ab5-bfa5-472e91ee91dd"
},
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": 20000,
"qualifiedAmountDetails": {
"prescriptionAmount": 1000
}
},
"visionAmount": 2000
}
},
"paymentMethod": {
"id": "ecb97780-2461-46f1-bc8f-e8f314ca08b0",
"card": {
"last4": "5556",
"expiryMonth": 10,
"expiryYear": 2026,
"zipCode": "12345",
"status": "ACTIVE",
"cardBrand": "VISA",
"manufacturerCard": false
},
"paymentMethodType": "CARD",
"nickname": "jbh",
"sourceProvider": {
"name": "CCG"
},
"paymentMethodDetails": {
"type": "CARD",
"last4": "5556",
"expiryMonth": 10,
"expiryYear": 2026,
"zipCode": "12345",
"status": "ACTIVE",
"cardBrand": "VISA",
"manufacturerCard": false
},
"default": false
}
}
}