A notification_url is informed in the batch creation. This section aims to explain how the notification_url is used by our Payout engine.
When every item in the batch reach a final status, FAILED or SUCCESS (more info about item's statuses here, the batch status is changed to COMPLETED and Payout Engine makes a maximum of 7 sequential attempts to notify Merchant’s domain in the notification_url.
We consider the notification as received successfully when the Merchant responds the notification with HTTP Code 204. If that happens, BoaCompra does not send further attempts.
If BoaCompra receives a response different from 204, notification retries will be done 7 times, with the intervals shown below:
| Attempt | Caused by | Retry interval |
|---|---|---|
| 1 | The batch status is changed to COMPLETED and Payout Engine must notify Merchant’s domain. | After 10 minutes. |
| 2 | The notification response was different from HTTP Code 204. | After 10 minutes. |
| 3 | The notification response was different from HTTP Code 204. | After 10 minutes. |
| 4 | The notification response was different from HTTP Code 204. | After 60 minutes. |
| 5 | The notification response was different from HTTP Code 204. | After 60 minutes. |
| 6 | The notification response was different from HTTP Code 204. | After 60 minutes. |
| 7 | The notification response was different from HTTP Code 204. | No more attempts. |
You can find an example of a notification attempt below, in a cURL format:
curl --location --request POST 'https://merchant.com.br/boacompra' \
--header 'Content-Type: application/json' \
--data-raw "{
'notification_type': 'payout',
'reference': '{batch-reference}'
}"