Servicio de creación de transacciones
El consumo del servicio de creación de transacciones es obligatorio en los flujos de pago y programación. Como resultado de esta operación, el comerciante obtendrá un NIT (pago) y / o un SID (cronograma) que será necesario para los siguientes pasos del flujo, así como el uso del servicio de consulta de transacciones.
NIT y SID tienen un límite de tiempo para su uso que por defecto es de 15 minutos pero se puede configurar en la tienda. Este plazo se configura en Portal Carat, y si se excede, la transacción cambiará de NOV (nuevo) a EXP (vencido), lo que impide futuras operaciones con esta transacción, por lo que es necesario consumir el servicio de creación de transacciones. de nuevo.
Detalles de la llamada#
- Recurso:
/v1/transactions - Método HTTP:
POST - Formato de la solicitud:
JSON - Formato de la resposta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
merchant_id | Código de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI |
merchant_key | Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. | < 80 AN | SI |
Content-Type | Debe enviarse con el valor application/json. | = 15 AN | SI |
Ejemplos#
A continuación, se muestran algunos ejemplos de llamadas al servicio de creación de transacciones mediante la herramienta cURL.
Creación de pago con confirmación automática#
Solicitud:
Respuesta:
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 creación de transacciones:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
merchant_usn | Nú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 esta es una clave posible para el acceso desde el lado de la tienda, aunque es opcional para el Carat, se recomienda encarecidamente que el campo sea formateado e enviado por la aplicación de la tienda. | < 12 N | NO |
installments | Utilizado para transacciones en cuotas, debe enviarse el valor correspondiente a la cuota/plan a utilizar. | < 2 N | SI |
authorizer_id | Código de autorizador en el Portal Carat. Más información. | < 3 N | NO |
amount | Monto total de la compra (en centavos). Ejemplo: 1,00 = 100 o 1.100,00 = 110000 - envíe el monto sin la coma y el punto. | < 12 N | SI |
soft_descriptor | Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. Más información | < 25 AN | NO |
| iata Este elemento contiene campos específicos de transacciones IATA. | |||
departure_tax | Impuesto de salida en centavos. | < 12 N | SÍ solo para installment_type = 6 o 7 |
first_installment | Entrada en transacciones IATA en centavos. Funcionalidad disponible solo para el adquirente de la red. | < 12 N | NO |
| additional_data | Elemento para enviar datos adicionales. | ||
| additional_data.payer | Elemento de envío de datos sobre el comprador. | ||
identification_number | Documento de identificación del comprador (CPF / RG). | < 20 AN | NO |
store_identification | Identificación del comprador para el almacenamiento de la tarjeta. Esta identificación debe ser única para cada usuario de la tienda. Pero cuidado, esta garantía de singularidad es responsabilidad exclusiva de la tienda, Carat no realizará ninguna validación. | < 20 AN | SÍ para la programación |
name | Nombre del comprador. | < 100 AN | NO |
surname | Apellido del comprador. | < 100 AN | No |
| additional_data.merchant | Elemento para el envío de datos relativos al comerciante. | ||
email | Dirección de correo electrónico del almacenista. | < 1024 AN | NO |
| additional_data.extra_param.prefixes | Elemento para el envío de prefijos SiTef, como CICLOS, CPLANO y VLRADD (No es necesario enviar los 3 prefijos en la transacción. Solo los prefijos que se necesitan). Si el prefijo enviado no es compatible con la tarjeta enviada, Carat invalidará la transacción, evitando la falsa impresión del uso de una determinada funcionalidad. Ejemplo: { "key" : "value" } -> { "CICLOS" : "01" }O para el caso de pagar ahora { "key" : "value" } -> { "CPLANO" : "06" } | ||
key | Nombre del prefijo. | < 1024 AN | NO |
value | Valor del prefijo. | < 1024 AN | NO |
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 creación de transacciones:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta del Carat. Cualquier código que no sea "0" significa un fallo. Más información. | < 4 N |
message | Mensaje de respuesta del Carat. | < 500 AN |
| payment | ||
status | Estado de la operación de pago en Carat. Más información. | = 3 AN |
nit | Identificador de la operación de pago en Carat. | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 N |
amount | Importe de la compra especificado por la tienda (en céntimos) al crear la transacción. | < 12 N |