Account Entry Webhook event: this message is triggered when there are any movements (credit or debit) on a Nuapay account.
Trigger: A transaction is processed on the Nuapay account.
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: AccountEntry
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 | AccountEntry |
root | resourceReference | string | optional | The business reference of the resource: the IBAN. |
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 transaction. Use the URI to retrieve details of the transaction via the Retrieve Transaction service. |
root | resourceId | string | Mandatory | The encoded technical ID of the resource being referenced in the event. |
root | resourceType | string | Mandatory | This is the type of the resource to which the URI is related. In this case it is an transaction resource. |
root | reasonCode | string | optional | Null for this event. |
root | resourceOwner | string | Mandatory | This is the identifier of the merchant resource to which this event notification is linked. |
root | resourceRemittanceInformation | string | optional | Remittance information. |
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": 1727154185004,
"eventType": "AccountEntry",
"resourceReference": "INCOMING_CREDIT_TRANSFER",
"resourceReferenceType": "TransactionType",
"resourceUri": "/accounts/abxqy89v2l/transactions/27pnkeod42",
"resourceId": "27pnkeod42",
"resourceType": "Transaction",
"reasonCode": null,
"resourceOwner": "tc47ygrg72",
"resourceRemittanceInformation": "PYMTREF INV-123"
}
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.