Credit Transfer Collection Initiation Webhook event
Trigger: A CT Collection moves to INITIATED 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 type:
| Webhook Event Type | Description |
| CreditTransferCollectionInitiated | Triggered where a Credit Transfer collection transitions to status = INITIATED |
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 | CreditTransferCollectionInitiated |
| root | resourceReference | string | optional | This can be the business reference of the resource, useful when filtering events via the Webhooks area of the Nuapay Console. |
| root | resourceReferenceType | string | optional | This can be a business reference of the resource, useful when filtering events via the Webhooks area of the Nuapay Console. |
| root | resourceUri | string | Mandatory | This is the URI of the resource. Use the URI to retrieve more details - see Retrieve Credit Transfer Collection. |
| root | resourceType | string | Mandatory | This is the type of the resource to which the URI is related. In this case it is a Credit Transfer Collection resource. |
| root | reasonCode | string | Optional | Null |
| root | resourceOwner | string | Mandatory | This is the identifier of the merchant resource to which this notification is linked. |
| root | resourceRemittanceInformation | string | optional | Null. |
JSON Sample
The following is an example of a Credit Transfer Collection Rejection 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": "CreditTransferCollectionInitiated",
"resourceReference": "E2E123456",
"resourceReferenceType": "Reference",
"resourceUri": "/credittransfers/collections/w24y5qgv2p",
"resourceType": "CreditTransferCollection",
"reasonCode": null,
"resourceOwner": "878UJK",
"resourceRemittanceInformation": null
}