Cancel creation service
Consuming this service is mandatory to the cancel flow. As a result from this operation, the merchant will obtain a NIT, which will be necessary for the next step of the flow.
NIT has a time limit for its use. This deadline is configured on Carat Portal, and if it's exceeded, the cancel transaction will go from status NOV (new) to EXP (expired), which blocks future operations with this transaction, making it necessary to consume the cancel creation service again.
Authenticity POST x signature#
Carat Portal has two methods of merchant authentication on the REST cancel interface: authenticity POST or signature.
In the authenticity POST method, Carat Portal will send the data of the newly created cancel transaction to the registered authenticity URL of the merchant.
In the signature method, the merchant must have a public RSA encryption key registered on Carat Portal and prepare a JWT signature (JSON Web Tokens) to be sent in the Authorization header. In this case, the cancel transaction information will be returned directly in the response. Learn more.
Call details#
- Resource:
/v1/cancellations - HTTP Method:
POST - Request format:
JSON - Response format:
JSON - Header parameters:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
merchant_id | Merchant code on Carat Portal. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on Carat Portal. The production and certification keys will be different. | < 80 AN | YES |
Content-Type | It must be sent with the value application/json. | = 15 AN | YES |
Authorization | Merchant's signature in the Bearer {signature} format. Example: Bearer JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NO |
Examples#
Below are some examples of the cancel creation service call using the cURL tool.
Cancel creation with authenticity POST#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Carat Portal will then answer through the merchant's URL using a HTTPS POST request (x-www-form-urlencoded) with the necessary information for further cancellation:
Authenticity POST:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
Cancel creation with signature#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
Response codes
See reference on API codes - response codes
Request parameters#
The table below describes the request parameters of the cancel creation service:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
esitef_usn | USN of the payment to be reversed. This information is returned by Carat Portal after the payment is approved. | = 15 N | YES |
order_id | Order ID of the payment to be cancelled. This field must only be sent in case of cancel via host. | < 40 AN | NO |
merchant_usn | USN generated by the merchant for the payment to be cancelled. This field must only be sent in case of cancel via host. | < 12 N | NO |
Authenticity POST parameters#
The table below describes the parameters sent by Carat Portal on the authenticity POST:
| Parameter | Description | Format |
|---|---|---|
nit | Identifier of the cancel transaction to be used in the next step of the flow. | = 64 AN |
pedido | Order ID of the payment to be cancelled. | < 20 AN |
nsu | USN generated by the merchant for the payment to be cancelled. | < 12 N |
codigoLoja | Merchant code on Carat Portal. | < 15 AN |
Carat Portal may also send new parameters without previous warning, which means that the merchant's application must be prepared to receive extra parameters and simply ignore them.
Response parameters#
If successful, the HTTP response code will be 201. Any other code must be interpreted as an error. The table below describes the response parameters of the cancel creation service:
| Parameter | Description | Format |
|---|---|---|
code | Carat Portal response code. Any code different from 0(zero) means failure. Learn more. | < 4 N |
message | Carat Portal response message. | < 500 AN |
cancellation These fields are only returned when using signature authentication. | ||
nit | Identifier of the cancel transaction to be used in the next step of the flow. | = 64 AN |
order_id | Order ID of the payment to be cancelled. | < 20 AN |
merchant_usn | USN generated by the merchant for the payment to be cancelled. | < 12 N |