You are here: Resources > Webhooks > Webhooks Overview

Webhooks Overview

Webhooks are HTTP notifications, dispatched to a specified URL when certain events are triggered in Nuapay. When working with the Nuapay API you will generate a request and receive a response; when using Webhooks you will receive a notification (similar to an API response) when certain activities (events) occur on your Nuapay account.

The following events are currently supported:

Event Type Description Webhooks Resource Type
Direct Debit R-Transaction

An R-transaction event is triggered when a payer's bank fail to process a Direct Debit payment. The payment status is updated to one of the following:

  • Rejected
  • Returned
  • Cancelled
  • Refunded
  • Refused
The Webhook will return a URI in its notification body; use this URI to retrieve the full details of the specific Direct Debit resource
Incoming Credit Transfer This event is triggered when a credit is applied to the Nuapay account . This will typically occur where a payer may have missed a Direct Debit payment (for example, due to insufficient funds) and decides to directly credit your Nuapay account. As with the r-transaction event, the Webhook notification will include a URI to the Incoming Credit Transfer resource in its notification body. Use this URI to retrieve full details of the resource.
Accepted Direct Debit Transaction The Direct Debit status is updated from EXPORTED to ACCEPTED on its value date. The Webhook will return a URI in its notification body; use this URI to retrieve the full details of the specific Direct Debit resource
Mandate Signature A mandate that was in a Pending status moves into Active status. This event is triggered when a paper mandate is signed; an electronic mandate is signed; or when a mandate is created in Active status in Nuapay (where the scheme settings automatically set the mandate status to Active) The Webhook will return a URI in its notification body; use this URI to retrieve the full details of the specific mandate resource
Credit Transfer Reject

A Credit Transfer R-transaction event is triggered when a beneficiary's bank fail to process a Credit Transfer payment. The payment status is updated to one of the following:

  • Rejected
  • Cancelled
The Webhook notification will include a URI to the Credit Transfer resource in its notification body. Use this URI to retrieve full details of the resource.