Our API Docs just got a new look!

Notifications

Every time a deposit changes its status, we will send you an asynchronous notification containing the ID of the deposit. The webhooks are sent to:

  1. the notification_url you sent in the request, or

  2. to the one you have configured under the section: Settings ➡️ API Access ➡️ Confirm URL.

Once received the notification, you should check its new status with the Get deposit status endpoint and update it on your end accordingly.

Firewall configurations

Example notification

{
    "deposit_id": 3000000001
}
Field
Format
Description

deposit_id

Number

ID of the deposit. Use this ID to check the status of the deposit.

Testing notification in Staging

Receiving notifications accordingly is part of our integration requirements checklist.

In the Staging environment, in order to test the full flow you can manually set a deposit to COMPLETED or CANCELLED status by: Logging in into the STG Merchant Panel ➡️ Transactions ➡️ Deposits.

Those options will change the status of the deposit, therefore sending the respective notification to your notification_url after a few minutes.

Approve/Cancel from the Deposits view.
You can also Approve/Cancel deposits from the Transaction details

Retry logic

Every time a deposit changes its status, we will send you a notification so you can check its status back.

In case that for some reason your server was unable to handle our notification and you returned an HTTP code different than 2XX, we will retry the notification up to 5 more times or until you respond with HTTP 2XX, whatever comes first.

The time between each of the 5 notifications attempts will be exponential: 5, 25, 125 and 625 minutes accordingly.

When a notification failed to be sent, it will be shown like this in our Merchant Panel:

If you see the errors from the screenshot above, it means the payment was successfully completed and the money was credited to your account but suddenly were not properly received. Keep reading to know how to resend the notifications.

Resend Notifications

In case your system was unable to handle the notification in any of the 5 attempts, you can always check its status with the Get deposit status endpoint.

If you need to trigger the check status by receiving our notification, once the issue preventing you from receiving our notifications was fixed, you can go to the Merchant Panel, locate the deposit (Transactions ➡️ Deposits) and click on the three dotted button under the section and then "Resend notification" to force a new notification to be sent.

Last updated

Was this helpful?