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 Portal 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 Portal 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.

Análisis de riesgo#

Para transacciones con análisis de riesgo (antifraude), se utilizan los [ mismos campos que la creación de pago con antifraude ] (pagamento-rest-begin.md#criação-de-pagamento-com-análise-de-risco-utlizando-o-anti-fraude-konduto).

Detalles de la llamada#

  • Recurso : / v1 / transaction
  • Operación HTTP : POST
  • Formato de solicitud : JSON
  • Formato de respuesta : JSON
  • Parámetros de encabezado :
Nombre del parámetroDescripciónTamañoObligatorio
Content-TypeValor fijo "application/json"= 15 ASi
merchant_idCódigo de tienda de Portal Carat. Los códigos de producción y certificación serán diferentes≤ 15 ASi
merchant_keyClave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes.<80 A

Ejemplos#

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

Autorización Previa#

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:

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

Parámetros de solicitud#

Nombre del parámetroDescripciónTamañoObligatorio
amountMonto total de la compra (en centavos). Ejemplo: 1,00 = 100 o 1,100,00 = 110000 - envíe el valor sin la coma y el punto<12N
encrypted_cardEste campo debe enviarse con un valor "true" si el número de tarjeta que se enviará en el siguiente paso del flujo utiliza cifrado SiTef.
La opción de enviar la tarjeta encriptada solo será posible con enrutamiento vía SiTef y es necesaria la configuración previa del SiTef en cuestión.
Opciones:
1. "true"
2. "false" (valor defaut)
<5 ANNo
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 Portal 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. < 20 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. Sepa mas< 22 ANNo
ecomm_pos_refEste campo enviará una identificación que aparecerá en el campo PDV del informe SiTef Web para transacciones de comercio electrónico.< 8 AFNo
installmentsNúmero de plazos. Envíe ‘1’ para transacciones en efectivo.< 2 N
installment_typeTipo de financiación a plazos:
valor 3 = cuotas con intereses de la compañía de tarjetas.
valor 4 = cuotas realizadas por la tienda y sin intereses (adoptar este valor por patrón/ default para transacciones en efectivo).
Valor 6 = pago a plazos con intereses del administrador (IATA).
valor 7 = pago a plazos realizado por la tienda y sin intereses (IATA).
El pago a plazos de IATA solo es utilizado por empresas en el segmento del transporte aéreo.
< 2 N
iataEste elemento contiene campos específicos de transacciones IATA.
departure_taxImpuesto de salida en centavos.< 12 NSÍ solo para installment_type = 6 o 7

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

A = alfanumérico

N = numérico

N A = no utilizado

Parámetros de respuesta#

Nombre del parámetroDescripciónTamaño
codeCódigo de respuesta de Portal 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 Portal Carat< 500 A
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
nitIdentificador de la transacción de preautorización de Portal Carat.= 64 A
order_idCódigo de pedido enviado por la tienda en la creación de la transacción < 20 AN
statusStatus de la transacción de preautorización en Portal Carat.= 3 A