Accepted Direct Debit Webhook event
Edit me

Webhook Message Details

This Webhook has a single event type: DirectDebitAccept

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 DirectDebitAccept
root resourceTechnicalId number Mandatory Unique identifier
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
root resourceUri string Mandatory This is URI of the Direct Debit resource. Use the URI in the Retrieve Direct Debit call.
root resourceType string Mandatory This is the type of the resource to which the URI is related. In this case it is a Direct Debit resource.
root resourceOwner string Mandatory This is the identifier of the merchant resource to which this notification is linked.
root reasonCode string optional Null for Direct Debits in ACCEPTED status.

JSON Sample

The following is an example of a Direct Debit Accept 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": "DirectDebitAccept",
	"resourceReference": "36C1234B-99C2-8G9C-D",
	"resourceReferenceType": "EndToEndId",
	"resourceUri": "/schemes/p2lqa394mv/mandates/lbyjxj5ebd/directdebits/wew3qnvdmq",
	"resourceType": "DirectDebit",
	"resourceOwner": "tc47ygrg72",
	"reasonCode": null
}