API Overview

PIN Debit Processing
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to PIN Debit Processing
- PIN Debit Integration
- PIN Debit Transactions
- PIN Debit Network Routing
- PIN Debit Processing Versus Credit Card Processing
- PIN Debit Reconciliation
- Track Data
- Terminal IDs
- Electronic Benefit Transfer
- Optional Features
  - Cash Back
  - Merchant Descriptors
  - Merchant-Inititated Reversals
  - Partial Authorizations
  - Payment Network Tokens
  - Surcharge Fees

PIN Debit Services
- PIN Debit Purchase with Contactless EMV
  - Required Fields for a PIN Debit Purchase with Contactless EMV
  - REST Example: PIN Debit Purchase with Contactless EMV
- PIN Debit Purchase with Contact EMV
  - Required Fields for a PIN Debit Purchase with Contact EMV
  - REST Example: PIN Debit Purchase with Contact EMV
- PIN Debit Purchase with Contactless EMV and Cash Back
  - Required Fields for a PIN Debit Purchase with Contactless EMV and Cash Back
  - REST Example: PIN Debit Purchase with Contactless EMV and Cash Back
- PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
  - Required Fields for a PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
  - REST Example: PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
- PIN Debit Partial Authorization with Swiped Track Data
  - Required Fields for a Swiped PIN Debit Partial Authorization
  - REST Example: PIN Debit Partial Authorization with Swiped Track Data
- PIN Debit Purchase with Contactless EMV and a Surcharge Fee
  - Required Fields for a PIN Debit Purchase with Contactless EMV and a Surcharge Fee
  - REST Example: PIN Debit Purchase with Contactless EMV and a Surcharge Fee
- PIN Debit Balance Inquiry with Contactless EMV
  - Required Fields for a PIN Debit Balance Inquiry with Contactless EMV
  - REST Example: PIN Debit Balance Inquiry with Contactless EMV
- PIN Debit Balance Inquiry with Swiped Track Data
  - Required Fields for a PIN Debit Balance Inquiry with Swiped Track Data
  - REST Example: PIN Debit Balance Inquiry with Swiped Track Data
- PIN Debit Credit with Swiped Track Data
  - Required Fields for a PIN Debit Credit with Swiped Track Data
  - REST Example: PIN Debit Credit with Swiped Track Data
- PIN Debit Credit with Contactless EMV
  - Required Fields for a PIN Debit Credit with Contactless EMV
  - REST Example: PIN Debit Credit with Contactless EMV
- Reverse a PIN Debit Purchase or Credit
  - Required Fields to Reverse a PIN Debit Purchase or Credit
  - REST Example: Reverse a PIN Debit Purchase or Credit
- PIN Debit EBT Purchase with a SNAP Voucher
  - Required Fields for a PIN Debit EBT Purchase with a SNAP Voucher
  - REST Example: PIN Debit EBT Purchase with a SNAP Voucher
- PIN Debit EBT Purchase with SNAP Account Swiped Track Data
  - Required Fields for a PIN Debit EBT Purchase with SNAP Account Swiped Track Data
  - REST Example: PIN Debit EBT Purchase with SNAP Account Swiped Track Data
- PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
  - Required Fields for a PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
  - REST Example: PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
- PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
  - Required Fields for a PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
  - REST Example: PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
- Credit a PIN Debit EBT Purchase with SNAP Account
  - Required Fields to Credit a PIN Debit EBT Purchase with SNAP Account
  - REST Example: Credit a PIN Debit EBT Purchase with SNAP Account
- Reverse a PIN Debit EBT Purchase
  - Required Fields to Reverse a PIN Debit EBT Purchase
  - REST Example: Reverse a PIN Debit EBT Purchase

Reverse a PIN Debit EBT Purchase

This section describes how to reverse a PIN debit EBT purchase.

You can reverse these types of transactions:

Purchase from a cash benefits account

Purchase from a SNAP account

Purchase manually entered from a SNAP account

Electronic voucher purchase from a SNAP account

Send the reversal request to the voids endpoint.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/voids

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/voids

The

{id}

is the transaction ID returned in the purchase response.

Required Fields to Reverse a PIN Debit EBT Purchase

clientReferenceInformation.code
clientReferenceInformation.partner.thirdPartyCertificationNumber: Cybersource provides the value for this field.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
paymentInformation.card.sourceAccountType: Set this field to
UA
.
paymentInformation.card.useAs: Leave this field blank.
paymentInformation.paymentType.name: Set this field to
CARD
.
paymentInformation.paymentType.subTypeName: Set this field to
DEBIT
.

Reverse a PIN Debit EBT Purchase

REST Example: Reverse a PIN Debit EBT Purchase

Request

{
  "clientReferenceInformation": {
    "code": "ABC1234", 
    "partner": {
      "thirdPartyCertificationNumber": "PTP1234"
    }
  },
  "paymentInformation": {
    "paymentType": {
      "name": "CARD",
      "subTypeName": "DEBIT"
    },
    "card": {
      "useAs": "",
      "sourceAccountType": "UA"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "101.00",
      "currency": "USD"
    }
  }
}

Response to a Successful Request

{
  "_links": {
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/6898911623526032004953"
    }
  },
  "clientReferenceInformation": {
    "code": "ABC1234" 
  },
  "id": "6898911623526032004953",
  "orderInformation": {
    "amountDetails": {
      "currency": "usd"
    }
  },
  "processorInformation": {
    "retrievalReferenceNumber": "123456188670",
    "responseCode": "00"
  },
  "reconciliationId": "6898907727276183604951",
  "status": "REVERSED",
  "submitTimeUtc": "2023-07-20T22:12:42Z",
  "voidAmountDetails": {
    "currency": "usd",
    "voidAmount": "101.00"
  }
}

Reverse a PIN Debit EBT Purchase

Back to top