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âmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.< 80 ANSIM
tokenToken obtido no serviço de criação de token Saiba mais.. Caso não seja enviado Authorization esse campo torna obrigatório= 66 ANCOND.
AuthorizationDeve 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 ANCOND.
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM

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

curl
--request PUT "https://{{url}}/e-sitef/api/v1/cards/{card.token}"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header 'token: XXXXX'
--data-binary
{
"card":{
"status":"ATV"
}
}
--verbose

Ativação do token do cartão com autenticação utilizando assinatura#

curl
--request PUT "https://{{url}}/e-sitef/api/v1/cards/{card.token}"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header 'Authorization: Bearer XXXXX'
--data-binary
{
"card":{
"status":"ATV"
}
}
--verbose

Resposta:

{
"code":"0",
"message":"OK. Transaction successful.",
"card":{
"token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
"suffix":"5555",
"bin": "544444",
"status": "ATV"
},
"store":{
"status":"CON",
"nsua":"18051600000560A",
"nita":"xxxxxxxxxxxxxxxxxxx",
"customer_id":"11122211122",
"authorizer_id":"2"
}
}

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

curl
--request PUT "https://{{url}}/e-sitef/api/v1/cards/{card.token}"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header 'token: XXXXX'
--data-binary
{
"card":{
"status":"INA"
}
}
--verbose

Inativação do token do cartão com autenticação utilizando assinatura#

curl
--request PUT "https://{{url}}/e-sitef/api/v1/cards/{card.token}"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header 'Authorization: Bearer XXXXX'
--data-binary
{
"card":{
"status":"INA"
}
}
--verbose

Resposta:

{
"code":"0",
"message":"OK. Transaction successful.",
"card":{
"token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
"suffix":"5555",
"bin": "544444",
"status": "INA"
},
"store":{
"status":"CON",
"nsua":"18051600000560A",
"nita":"xxxxxxxxxxxxxxxxxxx",
"customer_id":"11122211122",
"authorizer_id":"2"
}
}

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âmetroDescriçãoFormatoObrigatório
card.tokenIdentificaçã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 ANSIM
card
statusStatus do cartão. ATV (Ativo) e INA (Inativo).< 3 ANSIM

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âmetroDescriçãoFormato
codeCódigo de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais.< 4 N
messageMensagem de resposta do Carat.< 500 AN
store
statusStatus da transação de armazenamento no Carat. Saiba mais.= 3 AN
nsuaNúmero sequencial único da transação de armazenamento no Carat.= 15 AN
nitaIdentificação do armazenado no Carat.= 64 AN
customer_idIdentificação do comprador para armazenamento de cartão.< 20 AN
authorizer_idCódigo da autorizadora utilizada no armazenamento.< 3 N
card
tokenIdentificaçã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
bin6 primeiros dígitos do cartão do comprador.= 6 AN
statusStatus do cartão. ATV (Ativo) e INA (Inativo).< 3 AN