On This Page

Healthcare Processing Developer Guide

This section describes how to use this guide and where to find further information.
Audience and Purpose
This guide is written for application developers who want to use the
REST API
 to integrate healthcare payment processing into an order management system.
Implementing the
Cybersource
 payment services requires software development skills. You must write code that uses the API request and response fields to integrate the credit card services into your existing order management system.
Related Documentation
Visit the
Cybersource
 documentation hub to find additional technical documentation.
Customer Support
For support information about any service, visit the Support Center:

Recent Revisions to This Document

25.01

Initial release.

Introduction to Healthcare Processing

Healthcare processing is supported for card-present and card-not-present transactions. Include healthcare fields in authorization requests to identify purchases that qualify for healthcare debit cards. This additional data reduces the chance of the card issuer rejecting the transaction. Healthcare fields are not required for captures or other follow-on transactions.

Card Types

Healthcare transactions are supported on these card types:
  • Mastercard
  • Visa

Card-Present Transactions

Card-present transactions
 are transactions where both the card and the cardholder are present at the point of sale. In a card-present transaction, merchants are expected to follow standard card acceptance procedures to ensure that the card and the user are authenticated. The benefits of card-present transactions include:
  • Reduced transaction risks
  • Lower processing fees

Card-Not-Present Transactions

When a customer provides a card number, but you do not have access to the physical card, the purchase is known as a
card-not-present transaction
. This type of transaction typically occurs over the internet or through a call center. To process card-not-present transactions, use the credit card services described in this guide.
Card-not-present transactions pose an additional level of risk to your business because you cannot directly verify the customer’s identification as you can with card-present transactions. Features such as the Address Verification System (AVS) and Card Verification Numbers (CVNs) are offered in the credit card services. Using these services can reduce risk by verifying the customer’s information and notifying you when discrepancies occur.

Healthcare Payment Processing

This section describes how to process healthcare transactions.

Processing a Healthcare Sale

This section provides the information you need in order to process a healthcare sale transaction.
A sale combines an authorization and a capture into a single transaction.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments

REST Example: Processing a Healthcare Sale

Request
{
  "clientReferenceInformation": {
    "code": "HC-sale"
  },
  "processingInformation": {
    "capture": true
  },
  "orderInformation": {
    "billTo": {
      "country": "US",
      "lastName": "VDP",
      "address2": "test",
      "address1": "201 S. Division St.",
      "postalCode": "48104-2201",
      "locality": "Ann Arbor",
      "administrativeArea": "MI",
      "firstName": "RTS",
      "phoneNumber": "999999999",
      "district": "MI",
      "buildingNumber": "123",
      "company": "Visa",
      "email": "test@cybs.com"
    },
    "amountDetails": {
      "totalAmount": "100.00",
      "currency": "usd"
    }
  },
  "paymentInformation": {
    "card": {
      "expirationYear": "2031",
      "number": "4111111111111111",
      "securityCode": "123",
      "expirationMonth": "12",
      "type": "001",
      "productSubtype": "HC"
    }
  },
  "healthCareInformation": {
    "amountDetails": [
      {
        "amountType": "healthcare",
        "amount": "100"
      },
      {
        "amountType": "prescription",
        "amount": "50"
      },
      {
        "amountType": "clinic",
        "amount": "20"
      },
      {
        "amountType": "dental",
        "amount": "25"
      },
      {
        "amountType": "vision",
        "amount": "5"
      }
    ]
  }
}
Response to a Successful Request
{
  "_links" : {
    "void" : {
      "method" : "POST",
      "href" : "/pts/v2/payments/7338783664396669903091/voids"
    },
    "self" : {
      "method" : "GET",
      "href" : "/pts/v2/payments/7338783664396669903091"
    }
  },
  "clientReferenceInformation" : {
    "code" : "HC-sale"
  },
  "id" : "7338783664396669903091",
  "orderInformation" : {
    "amountDetails" : {
      "totalAmount" : "100.00",
      "authorizedAmount" : "100.00",
      "currency" : "usd"
    }
  },
  "paymentAccountInformation" : {
    "card" : {
      "type" : "001"
    }
  },
  "paymentInformation" : {
    "tokenizedCard" : {
      "type" : "001"
    },
    "card" : {
      "type" : "001"
    }
  },
  "pointOfSaleInformation" : {
    "terminalId" : "261996"
  },
  "processorInformation" : {
    "merchantNumber" : "000000092345678",
    "approvalCode" : "888888",
    "networkTransactionId" : "123456789619999",
    "transactionId" : "123456789619999",
    "responseCode" : "100",
    "avs" : {
      "code" : "X",
      "codeRaw" : "I1"
    }
  },
  "reconciliationId" : "57223666D4F86E0S",
  "status" : "AUTHORIZED",
  "submitTimeUtc" : "2024-12-11T00:52:46Z"
}