The transactional notification process occurs in two steps, which are transaction completion notification and status change notification.
| STEP | TYPE OF URL | DESCRIPTION | CONTENT | FORMAT |
|---|---|---|---|---|
| Transaction completion notification | Notification URL | It is sent after the shopper clicks Finalizar, generating the transaction. This notification is only sent when the transaction is finalized, regardless of whether there has been a change in status, that is, it does not mean that the transaction has been paid. | Contains all sales data. | POST or JSON |
| Status change notification | Status Change URL | It is sent when the status of the transaction changes. The status can be changed from “Pending” to “Paid”, “Cancelled” or “Not Completed”, among others. See the full list of statuses in the [Payment_status] table. | Contains the order identification data (it does not have cart data). | POST |
*Notifications are sent to the URLs defined by the establishment in Store Settings{:target="_blank"} and contain data on transactions carried out on the Payment Link.
It is worth noting that the Payment Link only notifies when a transaction is considered completed, that is, the shopperer has filled in all the details on the payment screen and clicked Finalizar
Example: The shopper accesses the payment link and chooses to pay via Pix. When you click Finalizar, the Payment Link generates the Pix key and sends the transaction completion notification to the store, which will have the “Pending” status. When the shopper makes payment via Pix, the transaction will have the status “Paid” and the Payment Link will send notification of the status change.
SSL Certificate
To receive notifications, the merchant needs to configure the SSL certificate. Additionally, there is no authentication implementation for sending notifications, so if the store endpoint has firewall layers, this may prevent notifications from being received.
Notification characteristics
Notification URLs are webhooks that can receive a notification via POST or via JSON:
| TYPE | DESCRIPTION |
|---|---|
| POST | Notification where the store is passive. |
| JSON | Notification where the store carries out a query. |
Notification format
In notifications supported by the Payment Link API, the format sent is Form Data, broken down by the Content-Type header ‘x-www-form-urlencoded’.
Expected return
The store server must send the return HTTPStatus = 200 (OK) to the Payment Link API, indicating that the notification was received and processed successfully.
Important
If the registered URL returns an error or is unavailable, three new attempts will be made, with an interval of one hour between each POST.
If the notification is not received, it is possible to request a resend manually in Order Details, by clicking on the arrow icon.