Mandate webhooks

Payment notifications sent to your webhook URI registered in the console, when a mandate becomes authorised, fails, or is revoked.

mandate_authorized

Notification that a mandate has been authorised

FieldTypeDescription
typestringType of the event ("mandate_authorized")
event_idstringA UUID for the event
event_versionstringThe version of the event schema
mandate_idstringThe unique ID for the mandate
authorized_atdatetimeAn RFC-3339 timestamp of when the mandate was authorized

mandate_failed

Notification that a mandate has failed to be created

FieldTypeDescription
typestringType of the event ("mandate_failed")
event_idstringA UUID for the event
event_versionstringThe version of the event schema
mandate_idstringThe unique ID for the mandate
failed_atdatetimeAn RFC-3339 timestamp of when the mandate failed to be authorized
failure_stagestringAn enum identifying where the mandate failed in it's lifecycle. Can be one of "authorization_required", "authorizing", "authorized", "revoked"
failure_reasonstringThe reason the payment failed. Example values to expect: "authorization_failed", "provider_error", "provider_rejected", "internal_server_error", "invalid_sort_code", "invalid_request", "unknown_error". Implementations should expect other values, since there may be more failure reasons added in future

mandate_revoked

Notification that a mandate has been revoked

FieldTypeDescription
typestringType of the event ("mandate_revoked")
event_idstringA UUID for the event
event_versionstringThe version of the event schema
mandate_idstringThe unique ID for the mandate
revoked_atdatetimeAn RFC-3339 timestamp of when the mandate was revoked
revocation_sourcestringAn enum identifying who revoked the mandate. Can be one of "client", "provider"

Did this page help you?