Ativação e Inativação Token do cartão
Detalhes da chamada#
- Recurso:
/v1/cards/{card.token} - Método HTTP:
PUT - 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 ativação e inativação do token do cartão utilizando a ferramenta cURL.
Ativação do token do cartão com autenticação 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
Ativação do token do cartão com autenticação utilizando assinatura#
Resposta:
Códigos de resposta
Veja a referencia no Códigos da API - códigos de resposta
Inativação do token do cartão com autenticação 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
Inativação do token do cartão com autenticação utilizando assinatura#
Resposta:
Códigos de resposta
Veja a referencia no Códigos da API - códigos de resposta
Parâmetros de requisição#
Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de ativação e inativação do token do cartão:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
card.token | Identificação do cartão armazenado. Este token é utilizado no lugar do cartão do comprador para realização de transações com o Carat. | = 88 AN | SIM |
| card | |||
status | Status do cartão. ATV (Ativo) e INA (Inativo). | < 3 AN | SIM |
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 ativação e inativação do token do cartão:
| 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 |
| store | ||
status | Status da transação de armazenamento no Carat. Saiba mais. | = 3 AN |
nsua | Número sequencial único da transação de armazenamento no Carat. | = 15 AN |
nita | Identificação do armazenado no Carat. | = 64 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 |
| card | ||
token | Identificação do cartão armazenado. Este token é 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 |
status | Status do cartão. ATV (Ativo) e INA (Inativo). | < 3 AN |