Status notification service

Important:

In order for the status notification to work in PIX REST transactions, it's necessary for the store to be configured on version 6. If you have any questions, contact the production team.

In the merchant's registration, the status URL must be informed. Carat Portal will send a POST containing the status of the transaction with the following parameters:

Parameter	Description	Format
nit	NIT of the transaction	= 64 A
pedido	Order id (generated by the merchant).	< 20 A
nsu	Sequential Number sent by the merchant.	< 12 N
nsuSitef	Unique Sequential Number (USN) of SiTef.	< 10 A
nsuHost	Unique Sequential number of the authorizer.	< 20 A
nsuesitef	Carat Portal's USN.	= 15 A
status	Order status. Learn more.	= 3 A
cupom	Customer's receipt.	< 4000 A
cupomEstabelecimento	Merchant's receipt.	< 4000 A
autorizadora	Authorizer code (on Carat Portal). Learn more.	< 10 A
tipoPagamento	Payment type. C=Credit D=Debit B=Boleto	= 1 A
dataSitef	Date of the payment. Format: DD/MM/YYYY hh:mm:SS Attention: this parameter is only sent on confirmed transactions routed by SiTef.	= 19 A
dataEfetivacao	Date of the payment. Format: DD/MM/YYYY hh:mm:SS Attention: this parameter is only sent on confirmed transactions not routed by SiTef.	= 19 A
mensagem	Authorizer message.	< 1024 A
codigoRespostaAutorizadora	Authorizer response code.	< 1024 A
rede	Authorizer name, whereby the payment is being performed.	< 500 A
numeroAutorizacao	Authorization number (generated by the authorizer)	= 6 A

Important:

In addition to the above parameters, Carat Portal can return other ones without prior notice. Please, be prepared to receive extra parameters beyond the parameters in the table above that can be ignored.

It isn't necessary to return data on the POST, however if the POST is not successful (HTTP Status-Code 200: OK), Carat Portal will try again until the configured number of times on the system, before giving up and leaving the transaction as pending notification, as seen on the images below.

Carat Portal's POST/HTTPS may not be immediate, as it will be asynchronous. The delay may vary according to the server load and the internet. If a problem occurs on sending, Carat Portal will try to resend the message after a certain time range, up to 3 times.

Not all of the parameters will be present on all transactions. Some parameters might not be sent depending on the payment method or if the transaction is not concluded, for example.

**Attempts of status change notifications:**

Failed attempts of status change notifications:

Status notification POST

To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br

curl -X POST \

https://www.storetest.com.br/status.php \

-H 'Content-Type: application/x-www-form-urlencoded' \

-H 'cache-control: no-cache' \

-d 'nsuSitef=315569&nit=9230d962f0afb40db64e082c37564f4b113c3e4fc6a5090c40813c4b0d80ca37&pedido=201808020001&status=CON'

Status notification POST parameters**

The table below describes the parameters sent by Carat Portal on the Status notification POST:

Parameter	Description	Format
nsuSitef	Transaction number at Sitef	= 6 AN
nit	Carat Portal transaction ID.	= 64 AN
pedido	Order ID of the payment created by merchant	< 20 AN
status	Transaction status on Carat	= 3 N

Carat Portal can also send new parameters without previous warning, which means that the merchant’s application must be prepared to receive extra fields and just ignore them.