Incoming Credit Transfer Webhook event
Trigger: Incoming Credit Transfer payment crediting the Nuapay IBAN.
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 just one event type: IncomingCreditTransfer
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 | IncomingCreditTransfer |
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 URI of the transaction resource. Use the URI to Retrieve the transaction. |
root | resourceType | string | Mandatory | This is the type of the resource to which the URI is related. In this case it is a Transaction resource. |
root | reasonCode | string | optional | Null for Incoming Credit Transfers. |
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 Incoming CT 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": "IncomingCreditTransfer",
"resourceReference": "EDS-1234-RFT-456-DEF-87",
"resourceReferenceType": "EndToEndId",
"resourceUri": "/accounts/qj29pkgnbx/transactions/ym37ygrg23",
"resourceType": "Transaction",
"reasonCode": null,
"resourceOwner": "tc47ygrg72",
"resourceRemittanceInformation": "PAYMENT FOR INVOICE 123ABC"
}
Tip: Webhook URIs do not include a version number. If you are attempting to retrieve a specific resource via a v2 API, please make sure to include the full
v2
path in your request.