On This Page

PIN Debit EBT Purchase with a SNAP Voucher

This section describes how to process a PIN debit EBT purchase with a SNAP voucher.

Fields Specific to This Use Case

These API request fields and values are specific to this use case:

processingInformation.electronicBenefitsTransfer.category: Set the value to
FOOD
.
processingInformation.electronicBenefitsTransfer.voucherSerialNumber
processingInformation.purchaseOptions.isElectronicBenefitsTransfer: Set the value to
true
.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Required Fields for a PIN Debit EBT Purchase with a SNAP Voucher

clientReferenceInformation.code
clientReferenceInformation.partner.thirdPartyCertificationNumber: Cybersource provides the value for this field.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
paymentInformation.card.expirationMonth: IMPORTANT

This field is optional if your account is configured for relaxed requirements for expiration date.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions
.
paymentInformation.card.expirationYear
paymentInformation.card.number
paymentInformation.card.sourceAccountType: Set the value to
UA
.
paymentInformation.card.useAs: Leave this field blank.
paymentInformation.paymentType.name: Set the value to
CARD
.
paymentInformation.paymentType.subTypeName: Set the value to
DEBIT
.
pointOfSaleInformation.entryMode: Set the value to
keyed
.
pointOfSaleInformation.terminalCapability
pointOfSaleInformation.trackData
processingInformation.commerceIndicator: Set the value to
retail
.
processingInformation.electronicBenefitsTransfer.category: Set the value to
FOOD
.
processingInformation.electronicBenefitsTransfer.voucherSerialNumber
processingInformation.purchaseOptions.isElectronicBenefitsTransfer: Set the value to
true
.

REST Example: PIN Debit EBT Purchase with a SNAP Voucher

Request

{
  "clientReferenceInformation": {
    "code": "ABCD123", 
     "partner": {
      "thirdPartyCertificationNumber": "PTP1234"
    }
  },
  "processingInformation": {
    "commerceIndicator": "retail",
    "purchaseOptions": {
      "isElectronicBenefitsTransfer": "true"
    },
    "electronicBenefitsTransfer": {
      "category": "FOOD",
      "voucherSerialNumber": "123451234512345"
    },
    "networkRoutingOrder": "K"
    },
  },
  "paymentInformation": {
    "card": {
      "number": "4012xxxxxxxxxxxx",
      "expirationMonth": "12",
      "expirationYear": "25",
      "useAs": "",
      "sourceAccountType": "UA"
    },
    "paymentType": {
      "name": "CARD",
      "subTypeName": "DEBIT"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "103.00",
      "currency": "USD"
    }
  },
  "pointOfSaleInformation": {
    "entryMode": "keyed",
    "terminalCapability": "4",
    "trackData": "%B4111111111111111^JONES/JONES ^3112101976110000868000000?;4111111111111111=33121019761186800000?"
  }
}

Response to a Successful Request

{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/payments/6898886939816860704951/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/6898886939816860704951"
    }
  },
  "clientReferenceInformation": {
  "code": "ABCD123" 
  },
  "id": "6898886939816860704951",
  "orderInformation": {
    "amountDetails": {
      "authorizedAmount": "103.00",
      "currency": "usd"
    }
  },
  "processingInformation": {
    "reconciliationId": "6898886939816860704951"
  },
  "processorInformation": {
    "systemTraceAuditNumber": "110391",
    "routing": {
      "network": "0029"
    },
    "approvalCode": "831000",
    "retrievalReferenceNumber": "123456199278",
    "transactionId": "000000000000000",
    "responseCode": "00"
  },
  "reconciliationId": "6898886939816860704951",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2023-07-03T12:02:34Z"
}