On This Page

{#jumplink-list}  
[Markdown](/docs/cybs/en-us/cp-retail/integration/ctv/rest/cp-retail/pd-processing/pd-bal-inq-swipe-task.md)  
Filter  
FILTER BY TAG

PIN Debit Balance Inquiry with Swiped Track Data {#pd-bal-inq-swipe-task}
=========================================================================

This section describes how to process a PIN debit balance inquiry with swiped track data.

Fields Specific to This Use Case
--------------------------------

This API request field and value is specific to this use case:

processingInformation.authorizationOptions.balanceInquiry
:
Set the value 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 {#pd-bal-inq-swipe-task_d7e16}
---------------------------------------

**Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#pd-bal-inq-swipe-task_d7e25}  
**Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#pd-bal-inq-swipe-task_d7e35}

Required Fields for a PIN Debit Balance Inquiry with Swiped Track Data {#pd-bal-inq-swipe-req-fields}
=====================================================================================================

[clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "")
:

[clientReferenceInformation.partner.thirdPartyCertificationNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-partner-third-party-certnum.md "")
:

[clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "")
:

[merchantInformation.merchantDescriptor.postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-postalcode.md "")
:

[merchantInformation.transactionLocalDateTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-transaction-local-date-time.md "")
:

[orderInformation.amountDetails.currency](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "")
:

[orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "")
:
Set the value to `0.00`.

[paymentInformation.card.sourceAccountType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-source-acct-type-a.md "")
:
Set the value to `UA`.

[paymentInformation.card.useAs](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-use-as.md "")
:
Leave this field blank.

[paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "")
:
Set the value to `CARD`.

[paymentInformation.paymentType.subTypeName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-sub-type-name.md "")
:
Set the value to `DEBIT`.

[pointOfSaleInformation.encryptedKeySerialNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-encrypted-key-serial-num.md "")
:

[pointOfSaleInformation.encryptedPin](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-encrypted-pin.md "")
:

[pointOfSaleInformation.entryMode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-entry-mode.md "")
:
Set the value to `swiped`.

[pointOfSaleInformation.pinBlockEncodingFormat](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-pin-block-encoding-format.md "")
:
Set the value to `1`.

[pointOfSaleInformation.terminalCapability](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-terminal-capability.md "")
:

[pointOfSaleInformation.trackData](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/pos-info-aa/pos-info-track-data.md "")
:

[processingInformation.authorizationOptions.balanceInquiry](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-auth-ops-balance-inquiry.md "")
:
Set the value to `true`.

[processingInformation.commerceIndicator](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-commerce-ind.md "")
:
Set the value to `retail`.

REST Example: PIN Debit Balance Inquiry with Swiped Track Data {#pd-bal-inq-swipe-ex-rest}
==========================================================================================

Request

```
{
  "clientReferenceInformation": {
    "code": "ABC123",
    "partner": {
      "thirdPartyCertificationNumber": "PTP1234"
    }
  },
  "processingInformation": {
    "commerceIndicator": "retail",
    "authorizationOptions": {
      "balanceInquiry": "true"
    }
  },
  "merchantInformation": {
    "transactionLocalDateTime": "20200323103021"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "0.00",
      "currency": "USD"
    }
  },
  "paymentInformation": {
    "paymentType": {
      "name": "CARD",
      "subTypeName": "DEBIT"
    },
    "card": {
      "useAs": "",
      "sourceAccountType": "UA"
    }
  },
  "pointOfSaleInformation": {
    "entryMode": "swiped",
    "terminalCapability": 4,
    "pinBlockEncodingFormat": 1,
    "encryptedPin": "52F20658C04DB351",
    "encryptedKeySerialNumber": "FFFF1B1D140000000005",
    "trackData": "%B4111111111111111^JONES/JONES ^3112101976110000868000000?;4111111111111111=33121019761186800000?"
  }
}
```

Response to a Successful Request

```
{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/payments/6879489725216492803092/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/6879489725216492803092"
    }
  },
  "clientReferenceInformation": {
    "code": "987654321" 
  },
  "id": "6879489725216492803092",
  "orderInformation": {
    "amountDetails": {
      "authorizedAmount": "0.00",
      "currency": "usd"
    }
  },
  "paymentInformation": {
    "accountFeatures": {
      "balances": [
        {
          "amountType": "02",
          "amount": "+20.00",
          "accountType": "00",
          "currency": "usd"
        }
      ]
    }
  }
},
  "processingInformation": {
    "reconciliationId": "6879489725216492803092"
  },
  "processorInformation": {
    "systemTraceAuditNumber": "837760",
    "routing": {
      "network": "0000"
    },
    "approvalCode": "831000",
    "retrievalReferenceNumber": "123456837760",
    "transactionId": "016153570198200",
    "responseCode": "00"
  },
  "reconciliationId": "6879489725216492803092",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2023-06-28T10:42:52Z"
}
```

RELATED TO THIS PAGE