Mandate Signature Event | Nuapay Developer Hub

Mandate Signature Webhook event

Trigger: A mandate moves to ACTIVE status.

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.

Webhook Message Details

This Webhook has the following event types:

Webhook Event Type	Description
MandateElectronicSign	When an electronic mandate is created via Nuapay as Active or is transitioned from Pending to Active, or to Active from Exported (BACS), for all channel. BACS and SEPA included
MandatePaperActivation	When a non-electronic Mandate transitions from Pending to Active or to Active from Exported (BACS), including Mandate-on-the-fly (MOTF). BACS and SEPA included
MandateCreation	When a non-electronic Mandate created in Nuapay with a status of Active is created, including MOTF for all channels.

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	MandateElectronicSign or MandatePaperActivation or MandateCreation
root	resourceReference	string	optional	This is the business reference of the resource (the Mandate ID/unique mandate 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	Null for mandates.
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": "MandateElectronicSign",
	"resourceReference": "MY-UNIQUE-MANDATE-REF",
	"resourceReferenceType": "MandateReference",
	"resourceUri": "/schemes/p2lqa394mv/mandates/lbyjxj5ebd",
	"resourceType": "Mandate",
	"reasonCode": null,
	"resourceOwner": "tc47ygrg72",
	"resourceRemittanceInformation": null
}