Payments

Refund webhooks

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

postWebhookrefunds

Headers

Tl-Signaturestring required

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

Payload

OR

Example payload

{
  "type": "refund_executed",
  "event_version": 1,
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "refund_id": "43d12d0f-d775-410f-aaff-482200c17017",
  "payment_id": "0afd1f6a-f611-48ce-9488-321129bb3a70",
  "executed_at": "2021-12-25T15:00:00.000Z",
  "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.