Recurring Payments — Mandates API
OpenAPI schemas for the Mandates API, used to power recurring payments.
Beta
The Mandates API is currently in beta. Request/response shapes might be subject to change. Please, reach out to your Volt contact before integrating.
Supporting documentation
Mandate management
Create mandate POST
Get mandate details GET
Update mandate request PATCH
Recall mandate DELETE
Recall a mandate that has not yet been authorised.
Cancel mandate POST
Cancel
an ACTIVE or SUSPENDED mandate (customer), or
NEW mandate (payer).
Suspend mandate POST
Suspend an ACTIVE mandate.
Release (unsuspend) mandate POST
Release a SUSPENDED mandate back to ACTIVE state.
Only mandate suspended by the same party can be released.
Create amendment request POST
Create amendment request while mandate is ACTIVE or SUSPENDED.
At least one of validity or payTo must be provided. The payTo field is only allowed...
Get amendment details GET
Retrieve amendment details. Recalled amendments return 404 Not Found.
Recall amendment request DELETE
Recall pending (NEW or AWAITINGAPPROVAL) amendment.
Recurring payments
Webhooks
Mandate status change notification Webhook
Sent to the notification URL provided during mandate creation.
| Type | Description |
|-------|-------------|
| mandaterequested | Mandate has been...
Amendment status change notification Webhook
Sent to the notification URL provided during mandate creation.
| Type | Description |
|-------|-------------|
| mandateamendmentrequested |...
How is this guide?
Last updated on