Mandates APIbetaMandate management
Release (unsuspend) mandate
Release a SUSPENDED mandate back to ACTIVE state.
Only mandate suspended by the same party can be released.
Authorization
Bearer AuthorizationBearer <token>
Bearer token using a JWT.
In: header
Path Parameters
id*string
Identifier of the mandate.
Format
uuidHeader Parameters
X-Volt-Api-Version*1
Version of the API used. Currently, version 1 is the only version.
Value in
- 1
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/mandates/497f6eca-6276-4993-bfeb-53cbbbba6f08/release" \ -H "X-Volt-Api-Version: 1"Empty
{ "code": "UNAUTHORISED", "message": "string"}{ "code": "ACCESS_DENIED", "message": "string"}{ "code": "RESOURCE_NOT_FOUND", "message": "string"}{ "code": "CONFLICT", "message": "string"}{ "code": "INTERNAL_SERVER_ERROR", "message": "string"}Suspend mandate POST
Suspend an `ACTIVE` mandate.
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 for PayTo mandates. If the mandate has already been used for payments, the `validity.from` (start date) cannot be amended.