Activation and Deactivation of Card Token

Call Details#

Resource: /v1/cards/{card.token}
HTTP Method: PUT
Request Format: JSON
Response Format: JSON
Header Parameters:

Parameter	Description	Format	Required
`merchant_id`	Merchant code on Carat. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat. The production and certification keys will be different.	< 80 AN	YES
`token`	Token obtained from the token creation service Learn more.. If `Authorization` is not sent, this field becomes mandatory.	= 66 AN	COND.
`Authorization`	The authentication signature of the merchant must be sent in `Bearer {signature}` format. Example: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`. If `token` is not sent, this field becomes mandatory.	< 2000 AN	COND.
`Content-Type`	Must be sent with the value `application/json`.	= 15 AN	YES

Flow#

Examples#

Below are some examples of calling the card token activation and deactivation service using the cURL tool.

Activation of the card token with token authentication#

Request:

To use this example, remember to set the variable {{url}} with the value
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

Activation of the card token with signature authentication#

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

Response:

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

Response codes

See reference on API codes - response codes

Deactivation of the card token with token authentication#