Skip to content

Retrieve A Card

Retrieve information about a saved card by cardId. You need to set “saveCard” to “true” value in the credit card payment request, then the cardId will be within the response of a successful payment.

HTTP Request

GET /v1/payments/vault/card/{{cardId}}

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
{
    "cardId": "8736453a-dad0-4f26-85f0-95e8787d0237",
    "card": {
        "cardHolderName": "card_holder_name",
        "expirationMonth": 9,
        "expirationYear": 2024,
        "brand": "VISA",
        "bin": "458124",
        "last4": "0000"
    }
}

HTTP Headers Details

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

PATH and Query Parameters

Parameter Type Description
cardId String The card ID received in a successful credit card payment. When you set “saveCard” to “true” value in the credit card payment request, the cardId will be within the response of a successful payment.

Response Body Parameters

Parameter Type Description
cardId String The card ID received in a successful credit card payment.
card JSON Card detail info.

Card Object in response Parameters

Parameter Type Description
cardHolderName String Cardholder's full name.
bin String first 6 digit number of the card
last4 String last 4 digit number of the card
brand String Credit card brand. such as VISA, MASTERCARD
expirationMonth Integer 1 or 2 digit number(s) representing the card's expiration month.
expirationYear Integer 4 digit numbers representing the card's expiration year.
Back to top