Webhooks are used to notify your application of changes to the status of Agreements, Payment Requests, Credits, Debits, etc as they are processed through the system.

By subscribing to our webhook events you can monitor the status of each transaction, and then trigger the appropriate next steps. While making Payments and Payment Requests, webhooks allow you to check the status of the transactions.

This article gives an overview of the webhook events you would expect to receive for the following scenarios.

The final States for a Payment (DC/NPP)Transaction

The final states for a Payment Request

The webhooks that are fired when you make a payment (from your primary account or the float account) are as follows:

For a successful NPP transaction, the final event that the system will fire is debtor_credit.cleared. Please note, that the above webhooks will be fired under the category payout

Note: For DC transactions, the cleared webhook does not guarantee that the funds have been settled into the end customer's account. The end customer's bank can take a few hours to settle the funds in the associated bank account.

It has been previously noticed, that for a Direct Credit transaction, the banks can get back to us after a day or two, informing us that the credit to the end customer's account has failed due to various reasons(eg: bank account closed). In this case, our system will trigger another webhook event debtor_credit.returned under the category payout and a bunch of other webhook events with the category payout_reversal.

You can refer to these events for such instances.

If you chose an NPP hybrid account, failed NPP payments are retried via DE, you would expect to receive the following webhooks:

Note: For DC transactions, the cleared webhook does not guarantee that the funds have been settled into the end customer's account. The end customer's bank can take a few hours to settle the funds in the associated bank account.

It has been previously noticed, that for a Direct Credit transaction, the banks can get back to us after a day or two, informing us that the credit to the end customer's account has failed due to various reasons(eg: bank account closed).

In this case, our system will trigger another webhook event with the category payout_reversal. You can refer to these events for such instances.

If you chose a standard Float account (with only NPP transactions or only DE), you would expect to receive the following webhooks:

Since the debit side of the transaction was successful, the credit will be reversed back into the original bank account. The below events will then be fired, under the category payout_reversal.

eg.

In addition, it is also suggested that you configure to the debtor_credit.channel_switched for transactions via a Hybrid float account.

If you chose a standard Float account (with only NPP transactions or only DE), you would expect to receive the following webhooks:

Note: Our system would mark the credit as cleared for a DC transaction based on the nearest available exchange point. The banks can get back to us within one or two business days informing us that the credit failed due to some reason. In this case, the final debtor_credit.returned event will be fired.

Since the debit side of the transaction was successful, the credit will be reversed back into the original bank account. The below events will then be fired, under the category payout_reversal.

While requesting a Payment, the Webhooks that will be fired are as follows :

While requesting the payment, in any case, if the payment request fails due to incorrect BSB, account number, insufficient funds, etc, the webhooks that will be fired are:

When you receive funds through a PayId, the webhooks that are fired are as follows:

You can also void a payment, by logging in to your Zepto account, navigating to the payment you created, and clicking the cancel button found on the top-right corner of the page. Please be mindful that you can only cancel/void the payment before it is processed.

The webhooks that will be triggered if you successfully cancel the payment before it matures are as follows,

There is also the scenario when your NPP payments fail to process, for example, the customer's bank is not NPP enabled. When this happens, the resulting behaviour and webhooks received will depend on the configuration you chose for your account float during setup.

You can also void a payment request, by logging in to your Zepto account, navigating to the payment request you created, and clicking the cancel button found on the top-right corner of the page. Please be mindful that you can only cancel a payment request before it is processed.

The webhooks that will be triggered if you cancel the payment request are as follows,

Feel free to reach out to us via the green bubble on the bottom right of the screen or email us at support@zepto.com.au. Happy to help with all your questions! :)