Servicio de ejecución de pagos
Después de consumir el servicio de creación de transacciones y obtener un NIT, puede continuar con el siguiente paso en el flujo: la llamada al servicio de ejecución de pagos. Esta operación también debe consumirse en los flujos de pago programados. En este caso, Portal Carat garantiza que la cita solo se activará si se confirma el pago.
Detalles de la llamada#
- Recurso:
/v1/payments/{nit} - Método HTTP:
POST - 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 tienda en el 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 pago mediante la herramienta cURL.
Pago#
Solicitud:
Respuesta:
Parámetros de solicitud#
En la siguiente tabla, hay una descripción de los parámetros de solicitud del servicio de pago:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
authorizer_id | Código de la autorizadora utilizado en el Carat. Más información. Si este campo no se envió en la etapa de creación de la transacción, se vuelve obligatorio al momento de consumir el servicio de pago. | < 3 N | COND. |
mcc | El MCC (Merchant Category Code) es un código que clasifica una empresa por el tipo de bienes o productos suministrados. | < 4 N | NO |
| card | Datos de la tarjeta. | ||
number | Número de tarjeta del comprador (PAN). | < 19 N | SI |
expiry_date | Fecha de vencimiento de la tarjeta en formato MMAA. Su obligación depende del comprador elegido. En la mayoría de los casos, este campo es obligatorio. | = 4 N | COND. |
security_code | Código de seguridad. Este campo puede no ser obligatorio si la empresa tiene un acuerdo en el contrato firmado con las redes adquirentes, solo para el pago de ciertos segmentos. Sin embargo, es posible configurar el campo obligatorio en la configuración de la tienda, consulte el soporte de Carat para obtener más información. Importante: un pago con horario agendado implica el almacenamiento de la tarjeta comprador de datos en el entorno de Carat. Sin embargo, por razones de seguridad, el código de seguridad no se puede almacenar. Por tanto, los pagos programados siempre se ejecutarán sin enviar el código de seguridad. | < 5 N | COND. |
| external_authentication | Este elemento recibe campos de resultado de autenticación MPI. | ||
version | Versión de 3DS utilizada en el proceso de autenticación (actualmente solo se acepta la versión 2) | < 1 AN | NO |
eci | Indicador de comercio electrónico: indica el nivel de seguridad de la transacción con autenticación del titular de la tarjeta | < 3 N | NO |
reference_id | Identificador de la operación de autenticación del titular de la tarjeta, realizada en un servicio ajeno al Carat | < 40 N | NO |
cavv | Valor de verificación de autenticación del titular de la tarjeta: código que indica el resultado de la autenticación del titular de la tarjeta. | < 40 N | 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 realización de pagos:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Carat. Cualquier código que no sea "0" significa error. Más información. | < 4 N |
message | Mensaje de respuesta de Carat. | < 500 AN |
| payment | ||
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
status | Estado de la transacción de pago en Carat. Más información. | = 3 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 centavos) al momento de la creación de la transacción. | < 12 N |
sitef_usn | Número secuencial único de la transacción de pago de SiTef. | = 6 N |
esitef_usn | Número secuencial único de la transacción de pago en Pago Online. | = 15 N |
customer_receipt | Recibo (a través del cliente). | < 4000 AN |
merchant_receipt | Recibo (vía establecimiento). | < 4000 AN |
authorizer_id | Código de la autorizadora utilizado. | < 4 N |
acquirer_id | Código del adquirente utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente utilizado en la transacción. | < 100 AN |
authorizer_date | Fecha de vigencia del pago devuelta por el autorizador en formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03 | = 16 D |
authorization_number | Numero de autorización. | < 6 AN |
host_usn | Autorizador NSU. | < 15 AN |
tid | ID de transacción en el adquirente. Este campo solo se devuelve en transacciones con adquirentes que no son SiTef. | < 40 AN |
eci | Indicador de comercio electrónico (indicador del nivel de seguridad de las transacciones de pago a través de Cielo e-Commerce). | < 3 AN |
payment_date | Fecha de vigencia del pago en Carat en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03 | = 16 D |
issuer | Marca el código devuelto por el autorizador. | < 5 AN |
xid | Campo XID devuelto en autenticaciones 3DS o ciertos adquirentes. | < 40 AN |