Mandates

Mandate webhooks

Sent to the webhook URI you registered in Console when a mandate becomes authorized, fails, or is revoked.

postWebhookmandates

Headers

Tl-Signaturestring required

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

Payload

OR

OR

OR

OR

Example payload

{
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "mandate_id": "be6db706-68f1-4e9c-ab09-b83d8e3ea60d",
  "authorized_at": "2021-12-25T15:00:00.000Z",
  "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.