Crear autorización previa

El flujo de la transacción de autorización previa se inicia consumiendo la operación beginTransaction, que generará una registro en Carat de una transacción con Status = NOV, y, devolverá a la aplicación el parámetro nit, que identificará esa transacción.

Nit tiene un período de uso configurado en Carat , si este límite de tiempo excede la transacción pasará de Status "NOV" al Status "EXP". En este caso, ya no se permitirá el uso de las mismas nit, si es necesario consumir la operación beginTransaction para generar otro nit válido.

Detalles de la llamada#

  • Recurso : /v1/transaction
  • Operación HTTP : POST
  • Formato de solicitud : JSON
  • Formato de respuesta : JSON
  • Parámetros de encabezado :
ParámetroDescripciónFormatoObligatorio
Content-TypeValor fijo application/json= 15 ANSI
merchant_idCódigo de tienda en el Carat. Los códigos de producción y certificación serán diferentes < 15 ANSI
merchant_keyClave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. < 80 ANSI

Ejemplos#

Abajo, se muestran algunos ejemplos de llamadas al servicio de creación de transacciones mediante la herramienta cURL.

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"order_id":"orderID",
"merchant_usn":"20190101",
"amount":"100",
"transaction_type":"preauthorization"
}
--verbose

Respuesta:

{
"message": "OK. Transaction successful.",
"pre_authorization": {
"status": "NOV",
"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id": "orderID",
"merchant_usn": "20190101",
"amount": "100"
}
}

Códigos de respuesta

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

Parámetros de solicitud#

ParámetroDescripciónFormatoObligatorio
merchant_usnNúmero secuencial único para cada pedido, creado por la tienda.
La NSU se utilizará en todas las comunicaciones con la tienda, con el fin de identificar el pedido. Como es una posible clave para el acceso desde el lado de la tienda, aunque es opcional para el Carat, se recomienda encarecidamente que el campo sea formateado y enviado por la aplicación de la tienda.
<12 NNo
order_idCódigo de pedido que se mostrará al comprador, definido por el comerciante. Se recomienda que sea diferente para cada pedido para facilitar la localización. < 40 ANNo
transaction_typeValor fijo "preauthorization"= 15 A
soft_descriptorTexto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. Más información.< 25 ANNO

Guía para el tipo de campo "Tamaño":

A = alfanumérico

N = numérico

N A = no utilizado

Parámetros de respuesta#

ParámetroDescripciónFormatoObligatorio
codeCódigo de respuesta de Carat. Cualquier código que no sea "0" significa error. Para obtener más información, consulte Códigos de respuesta.< 4 N
messageMensaje de respuesta de Carat< 500 A
statusStatus de la transacción de preautorización en Carat.= 3 A
nitIdentificador de la transacción de preautorización de Carat.= 64 A
order_idCódigo de pedido enviado por la tienda en la creación de la transacción < 40 AN
amountMonto de la transacción especificado por la tienda (en centavos) al momento de la creación de la transacción.<12 N
merchant_usnNúmero secuencial único enviado por la tienda en la creación de la transacción.<12 N