[NZ] Webhook Event Flows

Follow This Article To Find A List Of Webhooks That Would Be triggered When Making Payments or Payment Requests

Updated over a week ago

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.

Making a Payment

Via Direct Entry

Making a Payment Request (Direct Debit)

Voided Transactions

Successful Direct Entry Payment

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

  • payment.added

  • debit.scheduled

  • debtor_credit.scheduled

  • debit.maturing

  • debit.matured

  • debit.processing

  • debit.clearing

  • debit.cleared

  • debtor_credit.matured

  • debtor_credit.processing

  • debtor_credit.clearing

  • debtor_credit.cleared

Unsuccessful Direct Entry Payment

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

  • payment.added

  • debit.scheduled

  • debtor_credit.scheduled

  • debit.maturing

  • debit.matured

  • debit.processing

  • debit.clearing

  • debit.cleared

  • debtor_credit.matured

  • debtor_credit.processing

  • debtor_credit.clearing

  • debtor_credit.returned

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.

  • credit.scheduled

  • credit.matured

  • credit.processing

  • credit.clearing

  • credit.cleared

eg.

Successful Payment Request

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

  • payment_request.added

  • payment_request.approved

  • credit.scheduled

  • creditor_debit.scheduled

  • creditor_debit.matured

  • creditor_debit.processing

  • creditor_debit.clearing

  • creditor_debit.cleared

  • credit.matured

  • credit.processing

  • credit.clearing

  • credit.cleared

Unsuccessful Payment Requests

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:

  • payment_request.added

  • payment_request.approved

  • credit.scheduled

  • creditor_debit.scheduled

  • creditor_debit.matured

  • creditor_debit.processing

  • creditor_debit.clearing

  • creditor_debit.returned

  • credit.voided

Voided Payment

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,

  • payment.added

  • debit.scheduled

  • debtor_credit.scheduled

  • debit.voided

  • debtor_credit.voided

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.

Voided Payment Request

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,

  • payment_request.added

  • payment_request.approved

  • creditor_debit.scheduled

  • creditor_debit.matured

  • payment_request.cancelled

  • creditor_debit.voided

  • credit.voided

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! :)

Did this answer your question?