Mandate Amendment Event | Nuapay Developer Hub

Direct Debit Intruction Amendment Webhook event

Trigger: An ADDACS amendment is processed resulting in a DDI being updated.

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 DDI may be amended for the following reasons:

ADDACS Code	Description
3	Account transferred to a new bank or building society
C	Account transferred to a different branch of bank/building society
E	Instruction amended

You will typically:

Process the Webhook message and retrieve the URI for the DDI.
Use Retrieve Mandate/DDI
Extract the new debtor account details and update your internal systems as required.

Webhook Message Details

This Webhook has the following event types:

Webhook Event Type	Description
MandateAmendment	Nuapay are notified by the scheme of a DDI amendment. Bacs issue a notification file, referred to as an ADDACS, to notify of DDI amendments. 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	MandateAmendment
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	resourceId	string	Mandatory	The encoded technical ID of the resource being referenced in the event.
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 returned in the ADDACS 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": "MandateAmendment",
	"resourceReference": "MY-UNIQUE-MANDATE-REF",
	"resourceReferenceType": "MandateReference",
	"resourceUri": "/schemes/p2lqa394mv/mandates/gsbc1ebd",
	"resourceId": "gsbc1ebd",
	"resourceType": "Mandate",
	"reasonCode": 3,
	"resourceOwner": "tc47ygr1234",
	"resourceRemittanceInformation": null
}