Trusted payees

Payee batch state change

Sent as a batch of trusted payee operations moves through verification.

Payees added in a batch only become usable once the batch reaches CHALLENGE_COMPLETED; wait for that before attempting a payment to any of them.

Enable and configure webhooks in the Embedder Portal; recent events are listed on its Webhook Logs page. Weavr sends this event to {Webhook URL}/beneficiaries/batch/watch.

postWebhook/beneficiaries/batch/watch

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 required

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

signaturestring required

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

signature-v2string required

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.

Payload

idstring required

The unique identifier of the batch.

operation'CREATE' | 'REMOVE' required
tagstring

The tag field is a custom field that can be used to search and filter.

eventType'INITIALISED' | 'PENDING_CHALLENGE' | 'CHALLENGE_COMPLETED' | 'CHALLENGE_FAILED' | 'FAILED' required

The state the batch has reached:

  • INITIALISED: the batch was accepted and is awaiting a challenge.
  • PENDING_CHALLENGE: a Strong Customer Authentication challenge has been issued.
  • CHALLENGE_COMPLETED: the challenge succeeded and the batch has been applied. This is a final state.
  • CHALLENGE_FAILED: the challenge was not completed, so the batch was not applied. This is a final state.
  • FAILED: the batch could not be processed. This is a final state.
publishedTimestampinteger required

When the event was published. Epoch timestamp using millisecond precision.

Example payload

{
  "id": "123456789",
  "tag": "customer-123",
  "beneficiaries": [
    {
      "group": "Suppliers",
      "beneficiaryInformation": {
        "businessName": "Acme Ltd"
      },
      "beneficiaryDetails": {
        "instrument": {
          "id": "123456789",
          "type": "managed_accounts"
        }
      },
      "id": "123456789",
      "relatedOperationBatches": [
        {
          "batchId": "123456789",
          "operation": "CREATE"
        }
      ]
    }
  ],
  "publishedTimestamp": 1786118400000
}

Response

Event received.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.