TRtruelayer
Payouts

Payout webhooks

Sent to the webhook URI you registered in Console when a payout succeeds or fails.

postWebhookpayouts

Headers

Tl-Signaturestring required

A JWS with detached content, verifiable with our public key. See Webhook Request Signing

Payload

OR
OR

Example payload

{
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "payout_id": "0cd1b0f7-71bc-4d24-b209-95259dadcc20",
  "executed_at": "2021-12-25T15:00:00.000Z",
  "beneficiary": {
    "user": {
      "id": "f9b48c9d-176b-46dd-b2da-fe1a2b77350c"
    },
    "account_identifiers": [
      {
        "sort_code": "560029",
        "account_number": "26207729"
      }
    ]
  },
  "scheme_id": "faster_payments_service",
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  }
}

Response

Webhook Handled

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.