Activation and Deactivation of Card Token

import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';
import ResponseCodes from './codigos-de-resposta.md';

Call Details

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

Flow

sequenceDiagram
    STORE->>CARAT: 1. PUT /v1/cards/{card.token}
    CARAT-->>STORE: 2. nita, status
    

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

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

Deactivation of the card token with token authentication

Request:

To use this example, remember to set the variable {{url}} with the value

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

Deactivation 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":"INA"
	   }
	}
	--verbose

Response:

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

Request Parameters

The table below describes the request parameters for the card token activation and deactivation service:

Response Parameters

In case of success, the HTTP response code will be 200. Any other code should be interpreted as an error. The table below describes the response parameters for the card token activation and deactivation service: