List of Tokenized Cards

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';

Call details

• Resource: /v1/cards/list
• HTTP Method: GET
• Request format: JSON
• Response format: JSON
• Header Parameters:

Flow

sequenceDiagram
    participant MERCHANT
    participant CARAT
    MERCHANT->>+CARAT: 1. GET /v1/cards/list
    CARAT-->>-MERCHANT: 2. List of tokenized cards
    

Examples

Below are some examples of calling the tokenized card listing service using the cURL tool.

List of tokenized cards using token

Request:

To use this example, don't forget to define the variable {{url}} with the value

curl --location --request GET 'https://{{url}}/e-sitef/api/v1/cards/list?authorizer_id=1&status=ATV&page=0&limit=1' \
--header 'merchant_id: xxxxxxxxxxx' \
--header 'merchant_key: xxxxxxxxxxx' \
--header 'token: ca6ff575d51b013dc01ab4059c63aebb055af2963b8a31043daa33e16b20750e01'
--verbose

Listing of tokenized cards using signature

Request:

To use this example, don't forget to define the variable {{url}} with the value

curl --location --request GET 'https://{{url}}/e-sitef/api/v1/cards/list?authorizer_id=1&status=ATV&page=0&limit=1' \
--header 'merchant_id: LOJATESTE' \
--header 'merchant_key: F19DE00177C301DF24A865F11AA9B2567F604891F0F44DDAEFD69E3399E0B7E1' \
--header 'Authorization: Bearer XXXXX'

Response:

{
    "response_code": "0",
    "response_message": "OK. Transaction successful.",
    "cards": [
        {
            "status": "ATV",
            "authorizer_id": 1,
            "token": "S1uloKsLc+CLVhbOtf1SBg0WwTCbYLBsxh29jgKwhm-jNAfkQ1g-u6vcWfiV5gH1CfyAhu8Hl5fXR2ho+Cmrjw==",
            "bin": "455182",
            "suffix": "2345",
            "expiration_date": "1129",
            "customer_id": "1",
            "creation_date": "14/11/2023T00:21",
            "modification_date": "14/11/2023T02:56"
        },
        {
            "status": "ATV",
            "authorizer_id": 1,
            "token": "wAVdAIFCTkCTRZSL+BOH93hJYlBlD7Z4QhRDnyp6pbLQpfYE+rcUh740Tpf9Svvc5nLKZqKFuc4aZpTo41jc8Q==",
            "bin": "401200",
            "suffix": "1112",
            "expiration_date": "1212",
            "customer_id": "kakaroto",
            "creation_date": "07/04/2024T23:22",
            "modification_date": "09/05/2012T15:54"
        }       
    ],
    "current_page": "0",
    "total_pages": "1",
    "count": "2"
}

Request parameters

The table below describes the request parameters for the tokenized card listing service:

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. In the table below is the description of the response parameters of the tokenized card listing service: