Open Banking Payment Received Event

Received Payment Webhook event

Trigger: An Open Banking payment is credited to the merchant’s 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 a single event type: PaymentReceived

Tip: For Developer Dashboard users: select the PaymentReceived event.

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	PaymentReceived
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	resourceUri	string	Mandatory	This is URI of the payment resource. Use the URI in the Retrieve Payment call.
root	resourceType	string	Mandatory	This is the type of the resource to which the URI is related. In this case it is a payment 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	Remittance information related to the transaction.

JSON Sample

The following is an example of a Received Payment 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": "PaymentReceived",    
    "resourceReference": "31r8c5e2326f8b4d12345",
    "resourceReferenceType": "reference",    
    "resourceUri": "/payments/n7rklmvdmq",
    "resourceType": "payment",
    "reasonCode": null,
    "resourceOwner": "tc47ygrg72",
    "resourceRemittanceInformation": "ORDER XYZ"   
}