Beneficiary Update Webhook event

Webhook Message Details

This Webhook has just one event type: BeneficiaryAccountUpdate.

This Webhook is only possible for Bacs (GBP) beneficiaries and is triggered when an AWACS notification is received from Bacs.

Following a beneficiary update, when you Create a Credit Transfer payment, the 201 Created response will include:

  • The new (updated account details) in the beneficaryAccount object.
  • The old beneficiary account details in the originalBeneficiaryAccount object.

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 BeneficiaryAccountUpdate
root resourceReference string optional This is set to the beneficiary's name.
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 resource for RESTful API querying. Use the URI in the Retrieve Credit Transfer call.
root resourceType string Mandatory This is the type of the resource to which the URI is related. In this case it is a Beneficiay resource.
root reasonCode string optional Null for beneficiaries.
root resourceOwner string Mandatory This is the identifier of the merchant resource to which this notification is linked.

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": "BeneficiaryAccountUpdate",
    "resourceReference": "John Smith",
    "resourceReferenceType": "beneficiaryName",
    "resourceUri": "/beneficiary/ybo8zayk2q",
    "resourceType": "beneficiary",
    "reasonCode": null,
    "resourceOwner": "tc47ygrg72"

}