Mandates APIbetaMandate management

Release (unsuspend) mandate

POST
/mandates/{id}/release

Release a SUSPENDED mandate back to ACTIVE state.

Only mandate suspended by the same party can be released.

Authorization

Bearer
headerAuthorizationBearer <JWT>

Bearer token using a JWT.

Path Parameters

id*string

Identifier of the mandate.

Formatuuid

Header Parameters

X-Volt-Api-Version*1

Version of the API used. Currently, version 1 is the only version.

Value in1

Response Body

Accepted - Mandate release requested.

Example Request
curl -X POST 'https://gateway.sandbox.volt.io/mandates/497f6eca-6276-4993-bfeb-53cbbbba6f08/release' \  -H 'X-Volt-Api-Version: 1'
Example Response
Empty

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.