You are here: Resources > Webhooks > Mandate Signature Event

Mandate Signature Event

Trigger: A mandate moves to ACTIVE status.

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:        
    Parent Parameter Type Mandatory / Optional Description
    root eventTimestamp number Mandatory The Unix epoch timestamp
    root eventType string Mandatory

    MandateElectronicSign or MandatePaperActivation or MandateCreation

    root resourceTechnicalId number Mandatory
    root resourceReference string optional This can be the business reference of the resource, useful when filtering events via the Webhooks area of the Developer Dashboard.
    root resourceReferenceType string optional This can be a business reference of the resource, useful when filtering events via the Webhooks area of the Developer Dashboard.
    root resourceDetails object Mandatory Resource specific data grouping object
    resourceDetails uri string Mandatory This is URI of the resource for RESTful API querying.
    resourceDetails type string Mandatory This is the type of the resource to which the URI is related. In this case it is a mandate resource.
    resourceDetails reasonCode string optional null for mandates
    root organizationId number Mandatory The unique merchant identifier

    The following is an example of a Direct Debit Reject event JSON:

           
    POST http://example.com/webhooks
    Content-Type: application/json;charset=UTF-8
    X-Signature: 521ab01d030dee864fb44cc65a3be52ae591f46cde8d14d3e72fbc3790e4a304
    Content-Length: 261
    X-Request-Id: dc645679-71a5-498d-bb29-ec027948c7c1
    	{
    		"eventTimestamp": 1501169079000,
    		"eventType": "MandateElectronicSign",
    		"resourceReference": "Webhook1",
    		"resourceReferenceType": "MandateId",
    		"resourceUri": "/schemes/p2lqa394mv/mandates/lbyjxj5ebd",
    		"resourceType": "Mandate",
    		"reasonCode": null
    	}