Activación e Inactivación del Token de la Tarjeta

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

Detalles de la llamada

Recurso: /v1/cards/{card.token}
Método HTTP: PUT
Formato de la solicitud: JSON
Formato de la respuesta: JSON
Parámetros de encabezado:

Parámetro	Descripción	Formato	Obligatorio
`merchant_id`	Código de la tienda en Carat. Los códigos de producción y certificación serán diferentes.	< 15 AN	SÍ
`merchant_key`	Clave de autenticación de la tienda en Carat. Las claves de producción y certificación serán diferentes.	< 80 AN	SÍ
`token`	Token obtenido en el servicio de creación de token Más información.. Si no se envía `Authorization` este campo se vuelve obligatorio	= 66 AN	COND.
`Authorization`	Se debe enviar la firma de autenticación de la tienda en el formato `Bearer {firma}`. Ejemplo: `Bearer {TOKEN_JWT_EXAMPLE}`. Si no se envía `token` este campo será obligatorio	< 2000 AN	COND.
`Content-Type`	Debe enviarse con el valor `application/json`.	= 15 AN	SÍ

Flujo

Ejemplos

A continuación, se presentan algunos ejemplos de llamada al servicio de activación e inactivación del token de la tarjeta utilizando la herramienta cURL.

Activación del token de la tarjeta con autenticación utilizando token

Solicitud:

Para usar este ejemplo, no olvidar definir la variable {{url}} con el valor

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

Activación del token de la tarjeta con autenticación utilizando firma

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 {TOKEN_JWT_EXAMPLE}'
	--data-binary
	{
	   "card":{
	      "status":"ATV"
	   }
	}
	--verbose

Respuesta:

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

Inactivación del token de la tarjeta con autenticación utilizando token

Solicitud:

Para usar este ejemplo, no olvidar definir la variable {{url}} con el valor

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

Inactivación del token de la tarjeta con autenticación utilizando firma

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 {TOKEN_JWT_EXAMPLE}'
	--data-binary
	{
	   "card":{
	      "status":"INA"
	   }
	}
	--verbose

Respuesta:

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

Parámetros de solicitud

En la tabla a continuación se describe los parámetros de solicitud del servicio de activación e inactivación del token de la tarjeta:

Parámetro	Descripción	Formato	Obligatorio
`card.token`	Identificación de la tarjeta almacenada. Este token se utiliza en lugar de la tarjeta del comprador para realizar transacciones con Carat.	= 88 AN	SÍ
card
`status`	Estado de la tarjeta. `ATV` (Activo) y `INA` (Inactivo).	< 3 AN	SÍ

Parámetros de respuesta

En caso de éxito, el código de respuesta HTTP será 200. Cualquier otro código debe interpretarse como error. En la tabla a continuación se describe los parámetros de respuesta del servicio de activación e inactivación del token de la tarjeta:

Parámetro	Descripción	Formato
`code`	Código de respuesta de Carat. Cualquier código diferente de `0`(cero) significa fallo. Más información.	< 4 N
`message`	Mensaje de respuesta de Carat.	< 500 AN
store
`status`	Estado de la transacción de almacenamiento en Carat. Más información.	= 3 AN
`nsua`	Número secuencial único de la transacción de almacenamiento en Carat.	= 15 AN
`nita`	Identificación del almacenado en Carat.	= 64 AN
`customer_id`	Identificación del comprador para el almacenamiento de tarjeta.	< 20 AN
`authorizer_id`	Código de la autorizadora utilizada en el almacenamiento.	< 3 N
card
`token`	Identificación de la tarjeta almacenada. Este token se utiliza en lugar de la tarjeta del comprador para realizar transacciones con Carat.	= 88 AN
`suffix`	Últimos 4 dígitos de la tarjeta del comprador.	= 4 AN
`bin`	Primeros 6 dígitos de la tarjeta del comprador.	= 6 AN
`status`	Estado de la tarjeta. ATV (Activo) e INA (Inactivo).	< 3 AN