Servicio de confirmación de pago
Luego de crear y realizar un pago pendiente de confirmación, el comerciante debe llamar al servicio de confirmación para confirmar o cancelar el pago utilizando el mismo NIT obtenido en el primer paso del flujo.
#
Detalles de la llamada- Recurso:
/v1/payments/{nit}
- Método HTTP:
PUT
- Formato de solicitud:
query string
- Formato de respuesta:
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 | SÍ |
merchant_key | Clave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes. | < 80 AN | SI |
#
EjemploAbajo se muestra un ejemplo de una llamada de servicio de confirmación de pago utilizando la herramienta cURL.
Solicitud:
Respuesta:
Códigos de respuesta
Ver referencia en Códigos API - Códigos de respuesta
#
Parámetros de solicitudEn la siguiente tabla, hay una descripción de los parámetros de solicitud del servicio de confirmación de pago:
Parámetro | Descripción | Formato | Obligatorio |
---|---|---|---|
confirm | Este campo debe enviarse con el valor true si desea confirmar la transacción, o false si desea deshacer el pago. | < 5 T / F | SI |
amount | Valor a capturar. Debe ser menor o igual al autorizado. Los reconocimientos con un valor más bajo solo son compatibles con enrutamiento que no sean de SiTef. Si este campo no se envía, se utiliza el monto total de la transacción. | < 12 N | NO |
#
Parámetros de respuestaSi tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la tabla abajo se muestra la descripción de los parámetros de respuesta del servicio de confirmación de pago:
Parámetro | Descripción | Formato |
---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" significa error. Sepa mas. | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
payment | ||
status | Status de la transacción de pago en Portal Carat. Sepa mas. | = 3 AN |
payment_date | Fecha efectiva de pago en el Portal Carat en el formato DD/MM/AAAA'T'HH:mm . Ejemplo: 13/07/2017T16:03 | = 16 D |
host_usn | Autorizador NSU. | < 15 AN |