PIN Debit Balance Inquiry with Contactless EMV

This section describes how to process a PIN debit balance inquiry with contactless EMV.

Fields Specific to This Use Case

This API request field and value is specific to this use case:
processingInformation.authorizationOptions.balanceInquiry
Set this field to
true
.
These API response fields are returned in this use case:
paymentInformation.accountFeatures.accountType
paymentInformation.accountFeatures.balanceAmount
paymentInformation.accountFeatures.balanceAmountType
paymentInformation.accountFeatures.balanceSign
paymentInformation.accountFeatures.currency

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 Balance Inquiry with Contactless EMV

Set this field to
0.00
.
Set this field to
UA
.
Leave this field blank.
Set this field to
CARD
.
Set this field to
DEBIT
.
Required only when the card has a sequence number configured on the EMV chip.
Set this field to
contactless
.
Set this field to
true
.
Set this field to
retail
.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
PIN Debit Balance Inquiry with Contactless EMV

REST Example: PIN Debit Balance Inquiry with Contactless EMV

Request 
{
  "clientReferenceInformation": {
    "code": "ABC123",
    "partner": {
      "thirdPartyCertificationNumber": "PTP1234"
    }
  },
  "processingInformation": {
    "commerceIndicator": "retail",
    "authorizationOptions": {
      "balanceInquiry": "true"
    }
  },
  "paymentInformation": {
    "paymentType": {
      "name": "CARD",
      "subTypeName": "DEBIT"
    },
    "card": {
      "useAs": "",
      "sourceAccountType": "UA"
    }
  },
  "merchantInformation": {
    "transactionLocalDateTime": "20200323103021"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "0.00",
      "currency": "USD"
    }
  },
  "pointOfSaleInformation": {
    "entryMode": "contactless",
    "terminalCapability": 4,
    "emv": {
      "tags": "9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000",
      "cardSequenceNumber": "01"
    },
    "trackData": ";4111111111111111=33121019761186800000?"
  }
}
Response to a Successful Request
{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/payments/6898513109826580904004/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/6898513109826580904004"
    }
  },
  "clientReferenceInformation": {
  "code": "ABC123" 
  },
  "id": "6898513109826580904004",
  "orderInformation": {
    "amountDetails": {
      "authorizedAmount": "0.00",
      "currency": "usd"
    }
  },
  "paymentInformation": {
    "accountFeatures": {
      "balances": [
        {
          "amountType": "02",
          "amount": "+20.00",
          "accountType": "00",
          "currency": "usd"
        }
      ]
    }
  }
},
  "processingInformation": {
    "reconciliationId": "6898513109826580904004"
  },
  "processorInformation": {
    "systemTraceAuditNumber": "191877",
    "routing": {
      "network": "0000"
    },
    "approvalCode": "831000",
    "retrievalReferenceNumber": "123456191877",
    "transactionId": "016153570198200",
    "responseCode": "00"
  },
  "reconciliationId": "6898513109826580904004",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2023-07-20T11:08:31Z"
}
PIN Debit Balance Inquiry with Contactless EMV