State Webhooks
Like for our other resources (Payments, Paylinks), merchants can subscribe to mandate state webhooks via POST/v2/webhooks
. Mandate states include:
Mandate State | Definition |
---|---|
created | A new Mandate resource has been created. |
pending | Mandate is pending amendment authorization |
active | Mandate is active and eligible for payment requests. |
cancelled | Mandate has been cancelled by the consumer, payer bank, or merchant. |
declined | Mandate creation or amendment has been declined by the consumer or payer bank. |
expired | Mandate has passed its expiry date. |
failed | Mandate creation was unsuccessful. |
suspended | Mandate has been suspended (paused) by the consumer, payer bank, or merchant. |
Please note that separate calls are required to subscribe to Mandate and Payment webhooks.