Servicio de cancelación
Después de obtener un NIT de cancelación en el paso anterior, la tienda puede efectivamente realizar la reversión.
Después de una cancelación exitosa, la transacción de pago cambiará su estado a EST (extornado). Dependiendo de la adquirente, es posible realizar reversiones parciales, es decir, cancelar un importe inferior al pagado. En este caso, la transacción de pago mantendrá el satus CON.
Detalles de la llamada#
- Recurso:
/v1/cancellations/{nit} - Método HTTP:
PUT - Formato da solicitud:
JSON - Formato da 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 | 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 cancelación con la herramienta cURL.
Cancelación de pago a través de SiTef#
Solicitud:
Respuesta:
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud de servicio de cancelación:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
amount | Valor en centavos a cancelar. Es importante tener en cuenta que no todos los adquirentes admiten un extorno con un valor menor que el pago (cancelación parcial). Si este campo no se envía, Portal Carat utilizará el monto total del pago. | < 12 N | NO |
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 |
| card | |||
number | Número de tarjeta del comprador (PAN). Obligatorio al cancelar pagos a través de SiTef. | < 19 N | COND. |
expiry_date | Fecha de vencimiento de la tarjeta en formato "MMAY". Su obligación depende del comprador elegido. | = 4 N | COND. |
security_code | Código de seguridad. Obligatorio en función del contrato firmado con las redes adquirentes. | < 5 N | COND. |
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "200". 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 cancelación:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Carat. Cualquier código que no sea "0" (cero) significa falla. Más información. | < 4 N |
message | Mensaje de respuesta de Carat. | < 500 AN |
| cancellation | ||
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
status | Status de la transacción de cancelación de Carat. Más información. | = 3 AN |
nit | Número de identificación de la transacción de cancelación en el 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 momento de la creación de la transacción. | < 12 N |
amount | Monto de cancelación especificado en la tienda (en centavos). | < 12 N |
sitef_usn | Número secuencial único de la transacción de cancelación de SiTef. | = 6 N |
esitef_usn | Número secuencial único de la transacción de cancelación en el Carat. | = 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 autorización utilizado en la transacción. | < 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 efectiva de cancelación devuelta por el autorizador en formato DD / MM / YYYY'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03 | = 16 D |
authorization_number | Numero de autorización. | < 6 AN |
host_usn | NSU Autorizador. | < 20 AN |
tid | ID de transacción en el adquirente. Este campo solo se devuelve en transacciones con adquirentes externos al SiTef. | < 40 AN |
esitef_date | Fecha efectiva de cancelación en el Carat en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03 | = 16 D |
issuer | Código de la marca de la tarjeta devuelto por el autorizador. | < 5 AN |
authorizer_merchant_id | Código de afiliación del comerciante con la agencia autorizadora. | < 100 AN |