Listagem de cartões tokenizados

Detalhes da chamada#

Recurso: /v1/cards/list
Método HTTP: GET
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`token`	Token obtido no serviço de criação de token Saiba mais.. Caso não seja enviado `Authorization` esse campo torna obrigatório	= 66 AN	COND.
`Authorization`	Deve ser enviada a assinatura de autenticação da loja no formato `Bearer {assinatura}`. Exemplo: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`. Caso não seja enviado `token` esse campo será obrigatório	< 2000 AN	COND.
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Fluxo#

Exemplos#

Abaixo estão alguns exemplos de chamada do serviço de listagem de cartões tokenizados utilizando a ferramenta cURL.

Listagem de cartões tokenizados utilizando token#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

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

Listagem de cartões tokenizados utilizando assinatura#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

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'

Resposta:

{
    "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"
}

Parâmetros de requisição#

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de listagem de cartões tokenizados:

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 3 N	NÃO
`status`	Status do cartão armazenando no Carat `ATV`(Ativo) ou `INA`(Inativo).	= 3 AN	NÃO
`page`	Página da listagem. A primeira página tem valor `0`. Caso não seja enviada, assumiremos o valor `0`.	< 3 N	NÃO
`limit`	Número máximo de registros por página. Caso não seja enviado, assumiremos o valor máximo `100`	< 3 N	NÃO

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de listagem de cartões tokenizados:

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0`(zero) significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
`current_page`	Página atual dos registros.	< 4 AN
`total_pages`	Número total de páginas.	< 4 AN
`count`	Contagem total de registros..	< 4 AN
card
`status`	Status do cartão.	= 3 AN
`customer_id`	Identificação do comprador para armazenamento de cartão.	= 20 AN
`authorizer_id`	Código da autorizadora utilizada no armazenamento.	< 3 N
`token`	Identificação do cartão armazenado. Este token deve ser utilizado no lugar do cartão do comprador para realização de transações com o Carat.	= 88 AN
`suffix`	Últimos 4 dígitos do cartão do comprador.	= 4 AN
`bin`	6 primeiros dígitos do cartão do comprador.	= 6 AN
`expiration_date`	Data de vencimento do cartão no formato `MMAA`.	= 4 N
`creation_date`	Data de criação no armazenamento de cartão no formato: `DD/MM/AAAA'T'HH:mm`. Exemplo: `13/07/2017T16:03`	= 16 D
`modification_date`	Data que foi alterado no armazenamento do cartão no formato: `DD/MM/AAAA'T'HH:mm`. Exemplo: `13/07/2017T16:03`	= 16 D