Tokenización de tarjetas

Detalles de la llamada#

  • Recurso: / v1 / cards
  • Método HTTP: POST
  • Formato de solicitud: JSON
  • Formato de respuesta: JSON
  • Parámetros de encabezado:
ParámetroDescripciónFormatoObligatorio
merchant_idCódigo de tienda en Portal Carat. Los códigos de producción y certificación serán diferentes. < 15 ANSI
merchant_keyClave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes. < 80 ANSI
Content-TypeDebe enviarse con el valor application / json.= 15 ANSI

Fluir#

Ejemplos#

A continuación, se muestran algunos ejemplos de llamadas al servicio de almacenamiento de tarjetas con la herramienta cURL.

Almacenamiento de tarjetas#

Solicitud:

Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"expiry_date":"1222",
"number":"5444445555555555",
},
"authorizer_id":"2",
"merchant_usn":"16013439434",
"customer_id":"11122211122"
}
--verbose

Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"wallet_transaction_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=="
},
"authorizer_id":"2",
"merchant_usn":"16013439434",
"customer_id":"11122211122"
}
--verbose

Resposta:

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

Códigos de respuesta

Ver referencia en Códigos API - Códigos de respuesta

Parámetros de solicitud#

En la siguiente tabla se muestra una descripción de los parámetros de solicitud del servicio de almacenamiento de tarjetas:

ParámetroDescripciónFormatoObligatorio
authorizer_idCódigo de autorización del Portal Carat. [Más información.] (autorizadoras.md) < 3 NSI
merchant_usnNúmero secuencial único para cada pedido, creado por la tienda. < 12 NNO
customer_idIdentificación de comprador para almacenamiento de tarjetas. Esta identificación debe ser única para cada usuario de la tienda. Pero cuidado, esta garantía de unicidad es responsabilidad exclusiva de la tienda, Portal Carat no realizará ninguna validación. < 20 ANSI
card
numberNúmero de tarjeta del comprador (PAN). No se debe informar junto con el identificador de la billetera. < 19 NCOND.
expiry_dateFecha de vencimiento de la tarjeta en formato "MMAY". Su obligación depende del comprador elegido. En la mayoría de los casos, este campo es obligatorio.= 4 NCOND.
wallet_transaction_idIdentificador generado por la billetera digital. Actualmente solo es compatible con Google Pay. < 2048 ANCOND.

Advertencia: los campos card.number y card.wallet_transaction_id no deben definirse al mismo tiempo en la misma solicitud.

Parámetros de respuesta#

Si tiene éxito, el código de respuesta HTTP será "201". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de almacenamiento de tarjetas:

ParámetroDescripciónFormato
codeCódigo de respuesta de Portal Carat. Cualquier código que no sea "0" (cero) significa falla. [Más información.] (codigos-da-api.md#codigos-de-respuesta) < 4 N
messageMensaje de respuesta de Portal Carat. < 500 AN
store
statusEstado de la transacción de almacenamiento de Portal Carat. [Más información.] (codigos-da-api.md#status-de-almacenamineto)= 3 AN
nsuaNúmero secuencial único de la transacción de almacenamiento de Portal Carat.= 15 AN
nitaIdentificación de lo almacenado en el Portal Carat.= 64 AN
merchant_usnNúmero secuencial único enviado por la tienda. < 12 N
customer_idIdentificación de comprador para almacenamiento de tarjetas. < 20 AN
authorizer_idCódigo de autorización utilizado en almacenamiento. < 3 N
card
tokenIdentificación de tarjeta almacenada. Este token debe utilizarse en lugar de la tarjeta del comprador para realizar transacciones con Portal Carat.= 88 AN
suffixÚltimos 4 dígitos de la tarjeta del comprador.= 4 AN
bin6 primeros dígitos de la tarjeta del comprador.= 6 AN