TRtruelayer
Payments

Payment webhooks

Sent to the webhook URI you registered in Console when:

  • a payment is authorised.
  • a payment is executed.
  • a payment fails.
  • a payment settles.
  • a payment is creditable, according to criteria you specified.
  • a payment that has been executed has not settled within a duration you specified.
  • an indemnity claim is made against a payment.
  • a payment is reversed.
  • a Direct Debit payment arrived in the merchant account. The payment can still be reversed at this stage. Contact your ISM or CSM to know more.
postWebhookpayments

Headers

Tl-Signaturestring required

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

Payload

OR
OR
OR
OR
OR
OR
OR
OR

Example payload

{
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "payment_id": "0afd1f6a-f611-48ce-9488-321129bb3a70",
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  },
  "payment_method": {
    "retry": {
      "for": "30m"
    }
  },
  "authorized_at": "2021-12-25T15:00:00.000Z",
  "payment_source": {
    "account_identifiers": [
      {
        "sort_code": "560029",
        "account_number": "26207729"
      }
    ]
  }
}

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.