Status notification service

Important:
In order for the status notification to work in 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
`parcelas`	Number of installments.	< 2 N
`tipoFinanciamento`	Financing type chosen by the customer. `3` = installments with interest `4` = installments without interest	= 1 N
`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
`tid`	Transaction ID received only on transactions not routed by SiTef, such as Cielo e-Commerce, e-Rede, e.Rede REST, etc.	= 40 A
`eci`	Electronic Commerce Indicator (ECI)	= 3 A
`bandeira`	Issuer code used in the transaction. P.S. this field is sent only at transactions via SiTef.	< 5 N
`analise.status`	Risk analysis transaction status. `NOV` = new `EXP` = expired `ACC` = accepted `REJ` = rejected `REV` = review	= 3 A
`analise.codigo`	Antifraud institution's response code.	< 3 N
`analise.mensagem`	Antifraud institution's response message.	< 30 A
`NITTransacaoSecundaria`	Secondary transactions' NITs (separated by `\|` pipe) for split transactions.	< 1040 A
`binCartao`	BIN (6 first digits) of the card used on the payment.	= 6 N
`finalCartao`	Last 4 digits of the card used on the payment.	= 4 N

In addition to the fields described above, if a recharge transaction is linked the following fields will be returned:

Parameter	Description	Format
`recarga.nit`	Transaction NIT.	= 64 A
`recarga.nsusitef`	SiTef USN.	< 10 A
`recarga.nsuhost`	Authorizer USN.	< 20 A
`recarga.nsuesitef`	Carat Portal USN.	= 15 A
`recarga.status`	Order status.	= 3 A
`recarga.cupom`	Recharge customer receipt.	< 4000 A
`recarga.cupomestabelecimento`	Recharge merchant receipt.	< 4000 A
`recarga.codigoconcessionaria`	Dealer code (on GwCel).	< 10 A
`recarga.rede`	Acquirer code.	< 4 N
`recarga.dataefetivacao`	Payment date. Format: DD/MM/AAAA hh:mm:SS. ATTENTION: : this parameter is only returned on confirmed transactions made by SiTef.	= 19 A
`recarga.dataefetivacaositef`	Payment date. Format: DD/MM/AAAA hh:mm:SS. ATTENTION: : this parameter is only returned on confirmed transactions not done by SiTef.	= 19 A
`recarga.dadosconfirmacao`	Recharge confirmation data. (alphanumeric sequence).	= 12 A
`recarga.telefone`	Phone number.	< 20 N
`recarga.ddd`	Phone area code.	< 4 N
`recarga.valor`	Recharge amount.	< 12 N
`recarga.codigorespostahost`	Dealer response code.	< 4 N
`recarga.codigorespostasitef`	SiTef response code.	< 4 N
`recarga.mensagemrespostahost`	Dealer response message.	< 64 A
`recarga.mensagemrespostasitef`	SiTef response message.	< 64 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:

Home