Execution of the scheduled payments
Daily, Carat Portal will process the scheduled payments of the current day and will update the data of the executed schedules, like the current number of executions. If the schedule was already executed by the number of times defined by the merchant, it will have its status changed to FIN (finished) and will be disregarded in future processing procedures, as only schedules with ATV (active) status will be executed.
The current number of executions will only be incremented for payments that were confirmed or denied. In the case of denied transactions, Carat Portal won't reprocess them.
For each payment done, Carat Portal will send a POST to the merchant status URL configured on Carat Portal, informing many data of the recurrent payment.
Status notification of the recurrent payments#
On the merchant registration, a Status URL must be informed, where Carat Portal will send a HTTPS POST (x-www-form-urlencoded) containing the status of the transaction in addition to the following parameters:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
| Parameter | Description | Format |
|---|---|---|
nit | Identifier of the transaction. | = 64 A |
pedido | Order code. | < 20 A |
nsu | Unique sequential number sent by the merchant. | < 12 N |
nsuSitef | Unique sequential number returned by SiTef. | < 10 A |
nsuHost | Unique sequential number returned by the authorizer. | < 20 A |
nsuesitef | Unique sequential number generated by Carat Portal. | = 15 A |
status | Status of the transaction, as described in the table in item 24.1. | = 3 A |
cupom | Customer's receipt. It doesn't contain line breaks, as each line is separated by @ instead. | < 4000 A |
cupomEstabelecimento | Merchant's receipt. It doesn't contain line breaks, as each line is separated by @ instead. | < 4000 A |
autorizadora | Code of the authorizer on Carat Portal. | < 10 A |
tipoPagamento | Payment type: C=Credit, D=Debit, B=Boleto | = 1 A |
dataSitef | Payment authorization date returned by the acquirer in DD/MM/YYYY hh:mm:ss format. | = 19 A |
dataEfetivacao | Payment authorization date on Carat Portal in DD/MM/YYYY hh:mm:ss format. | = 19 A |
parcelas | Number of installments. | < 2 N |
tipoFinanciamento | Financing type selected by the customer. | = 1 N |
mensagem | Authorizer message. | < 1024 A |
rede | Acquirer name. | < 500 A |
numeroAutorizacao | Authorization number. | = 6 A |
tid | Transaction ID. This field will only be sent on payments with acquirers that are external to SiTef. | = 40 A |
eci | Electronic Commerce Indicator (ECI) of the transaction. | = 3 A |
bandeira | Issuer code. | < 5 N |
binCartao | BIN (first 6 digits) of the card used on the payment. | = 6 N |
finalCartao | Last 4 digits of the card used on the payment. | = 4 N |
Important:
Besides the parameters above, Carat Portal can return others without previous warning. Please, be prepared to receive extra parameters besides those in the table above, which 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.
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.
Schedule restrictions#
Listed below are functionalities that are unsupported by the schedule operation:
- Sending SiTef prefixes
- Payments with authentication
- Payments with fraud analysis
- IATA transactions
- Using cards with SiTef's encryption
- Sending the card security code on the scheduled payments