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.
Mandate Active
The Mandate Active notification indicates that a mandate is eligible for payment requests.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "active",
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_active",
"webhook_type": "mandate"
}
Mandate Cancelled
The Mandate Cancelled notification indicates that a mandate has been cancelled by the consumer, payer bank, or merchant.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "cancelled",
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_cancelled",
"webhook_type": "mandate"
}
Mandate Declined
The Mandate Declined notification indicates that a mandate creation or amendment has been declined by the consumer or payer bank.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "declined",
"state_reason": {
"code": "PAYER_ACTION_NO_RESPONSE",
"message": "The payer failed to authorise the mandate within the alloted time.",
},
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_declined",
"webhook_type": "mandate"
}
Mandate Expired
The Mandate Expired notification indicates that a mandate has passed its expiry date.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "expired",
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_expired",
"webhook_type": "mandate"
}
Mandate Failed
The Mandate Failed notification indicates that a mandate creation was unsuccessful.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"latest_error": {
"code": "INTERNAL_SYSTEM_ERROR",
"type": "INTERNAL_ERROR",
"message": "An Unexpected Error Occurred. Contact Banked for More Info.",
},
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "failed",
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_failed",
"webhook_type": "mandate"
}
Mandate Pending
The Mandate Pending notification indicates that a mandate is awaiting amendment authorisation.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "pending",
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_pending",
"webhook_type": "mandate"
}
Mandate Suspended
The Mandate Suspended notification indicates that a mandate has been suspended (paused) by the consumer, payer bank, or merchant.
json
{
"created_at": "2019-10-31 16:45:34 UTC",
"currency": "GBP",
"description": "free text description",
"external_reference": "ref-12345",
"id": "a6941fd1-f5cb-4948-814d-df03540149fb",
"mode": "live",
"network_mandate_id": "2b01c03b-434b-4a68-aa1a-c99a8380391a",
"payments_terms": {
"variable_terms": {
"count_per_period": 10,
"frequency": "MANDATE_PAYMENTS_FREQUENCY_ADHOC",
"max_payment_amount": 1000
},
},
"state": "suspended",
"state_reason": {
"code": "UNKNOWN",
"message": "The status transition occurred for an unknown reason",
},
"validity_end_date": "2025-03-16",
"validity_start_date": "2024-03-16",
"webhook_event": "mandate_suspended",
"webhook_type": "mandate"
}