Direct Debit Intruction Reject Webhook event
Trigger: An AUDDIS rejection is processed resulting in a DDI transitioning from EXPORTED to CANCELLED status. This event only impacts DDIs created in the Bacs scheme.
Tip: Webhooks may be updated from time to time and it is important to consider the Versioning and Backward Compatibility guidelines when developing your solution. We recommend that your handler ignores new fields it is not expecting; any new fields that may be added will provide new information, which may be safely ignored.
A Direct Debit Instruction (mandate) created under Bacs:
- Must be passed to the scheme to be approved before collections may be made against it.
- Where the DDI is not approved (e.g. the payer’s account does not allow Direct Debit payments), the scheme will inform Nuapay via an Automated Direct Debit Instruction Service (AUDDIS) notification. A specific AUDDIS error code is assigned.
- Nuapay will set the DDI status to
CANCELLED
.
Webhook Message Details
This Webhook has the following event types:
Webhook Event Type | Description |
MandateReject | Nuapay may be notified by the scheme of a rejection of a DDI. Once processed, Nuapay will trigger this notification, provided the partner/merchant has been configured to receive it. |
Webhook Event Message Details
The following table describes the details of the Webhook notification:
Parent | Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|---|
root | eventTimestamp | number | Mandatory | The Unix epoch timestamp |
root | eventType | string | Mandatory | MandateReject |
root | resourceReference | string | optional | This is the business reference of the resource (the Mandate ID/unique mandate/DDI reference). |
root | resourceReferenceType | string | optional | This is set to MandateReference for this message. |
root | resourceUri | string | Mandatory | This is URI of the resource allowing you to query the mandate details. See Retrieve Mandate. |
root | resourceType | string | Mandatory | This is the type of the resource to which the URI is related. In this case it is a mandate resource. |
root | reasonCode | string | Optional | The Reason code as assigned during the AUDDIS import. |
root | resourceOwner | string | Mandatory | This is the identifier of the merchant resource to which this notification is linked. |
root | resourceRemittanceInformation | string | optional | Remittance information related to the transaction. |
JSON Sample
The following is an example of an electronic mandate signing event JSON:
Headers:
POST | http://example.com/webhooks |
Content-Type: | application/json;charset=UTF-8 |
x-signature: | 123ab01d030dee864fb44cc65a3be52ae591f46cde8d14d3e72fbc3790e4a304 |
Content-Length: | 261 |
X-Request-Id: | dc645679-71a5-498d-bb29-ec027948c7c1 |
JSON Request Body
{
"eventTimestamp": 1501169079000,
"eventType": "MandateReject",
"resourceReference": "MY-UNIQUE-MANDATE-REF",
"resourceReferenceType": "MandateReference",
"resourceUri": "/schemes/p2lqa394mv/mandates/awtc1ebd",
"resourceType": "Mandate",
"reasonCode": B,
"resourceOwner": "tc47ygrg72",
"resourceRemittanceInformation": null
}