Skip to content

Trusted Payees

Webhooks

Beneficiary batch
Webhook

Request

Notification that a Beneficiary batch has been submitted.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger, (int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestringrequireddeprecated

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

Bodyapplication/jsonrequired
idstring^[0-9]+$required
operationstring(BeneficiaryBatchOperation)required
Enum:"CREATE""REMOVE"
tagstring, <= 50 characters^[a-zA-Z0-9_-]+$
publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

eventTypestring(BeneficiaryBatchEventType)required
Enum:"INITIALISED""FAILED""PENDING_CHALLENGE""CHALLENGE_FAILED""CHALLENGE_COMPLETED"
beneficiariesArray of objects(LegacyBeneficiary)required
Payload
{
  "id": "string",
  "operation": "CREATE",
  "tag": "string",
  "publishedTimestamp": "string",
  "eventType": "INITIALISED",
  "beneficiaries": [
    { … }
  ]
}

Responses

Success - No Content