get https://api-uat.payments.paynow.afterpaytouch.dev/v1/cards/verification?originalRequestId=
Use this API to retrieve the card token
This interface is called by the merchant backend to retrieve the token stored in the Afterpay backend
The interface provided is an HTTP GET request and JSON response.
HTTP Request
GET https://<env>/v1/cards/verification?originalRequestId={originalRequestId}
Request headers
| Parameter | Mandatory | Description |
|---|---|---|
| Content-Type | yes | application/json |
| Accept | yes | application/json |
| Authorization | yes | Bearer Access-admin-oauth-token (Refer Authentication) |
| User-Agent | yes | All requests must include information about the Merchant, Platform, Channel and Service. For example Merchant/SED; Platform/Merchant-SP; MerchantId/ABC123; Channel/app; CountryCode/AU; System Information/Java/8.3; Service/Unlock |
| Request-Id | yes | Unique identifier for retrieve token details request provided by the merchant |
Query parameters
| Name | Type | Mandatory | Description | Comment |
|---|---|---|---|---|
| originalRequestId | string | yes | Request-Id of the original card verification request completed earlier (request ID provided in the original transaction.) |
Sample Example
curl -v -X GET https://<env>/v1/cards/verification?originalRequestId={originalRequestId} \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <Access-Token>" \
-H "User-Agent: Merchant/ABC; Platform/Merchant-FE; MerchantId/ABC123; Channel/autopayment; CountryCode/AU System Information/Java/8.3; Service/Auto-recharge"\
-H "Request-Id: 8456732415666565656565656565657" \
Response body
| Name | Type | Mandatory | Description | Comment |
|---|---|---|---|---|
| id | string | yes | Uniquely identifies each transaction. This is generated by Afterpay and is included in the response to each interaction | |
| receiptId | string | yes | The unique identifier representing the tokenisation | |
| token | string | yes | The unique identifier for the customer's stored payment card that can be used for payment; card token | |
| last4Digits | string | yes | The last 4 digits of the payment card may be used for visual identification of the payment card | |
| creditLimit | number | no | ||
| cardBrand | string | no | The scheme issuing the card e.g. Visa, Mastercard, American Express | |
| cardType | string | no | Indicates the payment card type and whether it is associated with a credit or debit account | |
| cardSubType | string | no | Indicates the non-standardised, marketing sub-classification of the card | |
| issuingBank | string | no | The name of the institution issuing the payment card | |
| country | string | no | The country in which the card was issued |
Sample Example
Status: 200 OK
{
"id": "13e753e2e4a4b2f692b573e5fbe98b7b5523586a",
"receiptId": "32432",
"token": "6966af4975984c30ae2e2c18985bc21c",
"last4Digits": "1111",
"creditLimit": 123,
"cardBrand": "VISA",
"cardType": "DEBIT",
"cardSubType": "pre-paid giftcard",
"issuingBank": "Commonwealth Bank of Australia",
"country":"AU"
}