Cancelar el servicio de creación
El consumo de este servicio es obligatorio en el flujo de cancelación. Como resultado de esta operación, el comerciante obtendrá un NIT que será necesario para el siguiente paso del flujo.
NIT tiene un límite de tiempo para su uso. Este plazo se configura en el Portal Carat, y si se excede, la transacción de cancelación cambiará del estado NOV (nuevo) a EXP (vencido), lo que impide futuras operaciones con esta transacción, por lo que es necesario consumir el servicio de nuevo Creación de cancelación.
POST de autenticidad X Firma#
Portal Carat tiene dos formas de autenticación de la tienda en la interfaz de cancelación REST: autenticidad POST o firma.
En el método POST de autenticidad, Portal Carat enviará los datos de la transacción de cancelación recién creada a la URL de autenticidad registrada de la tienda.
En el método de firma, la tienda debe tener una clave pública de encriptación RSA registrada en Portal Carat y debe ensamblar una firma JWT (JSON Web Tokens) para ser enviada en el encabezado Authorization. En este caso, la información de la transacción de cancelación se devolverá directamente en la respuesta del servicio. Más información
Detalles de la llamada#
- Recurso:
/v1/cancellations - Método HTTP:
POST - Formato de solicitud:
JSON - Formato de respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
merchant_id | Código de tienda en 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 |
Authorization | La firma de autenticación de la tienda debe enviarse en el formato Bearer {firma}". Ejemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg`. | < 2000 AN | NO |
Ejemplos#
Abajo, se muestran algunos ejemplos de llamadas al servicio de creación de cancelación mediante la herramienta cURL.
Creación de cancelación POST de autenticidad#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Posteriormente, Portal Carat enviará una solicitud POST HTTPS (x-www-form-urlencoded) a la URL registrada, este POST contiene la información necesaria para proceder con la cancelación:
POST de autenticidad:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Creación de cancelación con firma#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respueta:
Códigos de respuesta
Ver referencia en Códigos API - Códigos de respuesta
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud para el servicio de creación de cancelaciones:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
esitef_usn | NSU de pago a cancelar. Portal Carat devuelve esta información después de que se aprueba el pago. | = 15 N | SI |
order_id | Código de pedido del pago a cancelar. Este campo solo debe enviarse en caso de cancelación a través del host. | < 40 AN | NO |
merchant_usn | NSU generada en la tienda del pago que se va a liquidar. Este campo solo debe enviarse en caso de cancelación a través del host. | < 12 N | NO |
Parámetros POST de autenticidad#
En la siguiente tabla, hay una descripción de los parámetros enviados por el Portal Carat en el POST de autenticidad:
| Parámetro | Descripción | Formato |
|---|---|---|
nit | Cancele el identificador de transacción que se utilizará en el siguiente paso del flujo. | = 64 AN |
pedido | Código de pedido del pago a cancelar. | < 20 AN |
nsu | NSU generada en la tienda del pago que se va a cancelar. | < 12 N |
Código de tienda | Código de tienda en Portal Carat. | < 15 AN |
Portal Carat también puede enviar nuevos parámetros sin previo aviso, lo que significa que la solicitud del comerciante debe estar preparada para recibir campos adicionales y simplemente ignorarlos.
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 cancelaciones:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" (cero) significa falla. Más información. | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
cancellation | Estos campos solo se devuelven cuando se usa la autenticación firmada. | |
nit | Cancele el identificador de transacción que se utilizará en el siguiente paso del flujo. | = 64 AN |
order_id | Código de pedido del pago a cancelar. | < 20 AN |
merchant_usn | NSU generada en la tienda del pago que se va a cancelar. | < 12 N |