Cancel, revoke or restart an e-mandate

Once created, an e-mandate can only change status. You change it with PATCH /v1/e-mandates/{emandate_id}, sending the target status.

What you can do

Target status	Use it to	Allowed from
`cancelled`	Stop an e-mandate you no longer need, whether or not the customer has signed it.	`draft`, `active`
`revoked`	Record that the customer has withdrawn their consent to a signed mandate.	`active`
`draft`	Restart the customer's journey on an unsigned e-mandate, for example after a failed verification. The customer gets a new verification attempt through the same `links.next`.	`draft`

cancelled and revoked are final: to collect from the same customer again, create a new e-mandate.

Send the request

curl -X PATCH "https://api.sandbox.fintecture.com/v1/e-mandates/9e2c7e69-732d-4adf-bede-f4ad15d9e8a3" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "data": {
      "type": "e-mandates",
      "id": "9e2c7e69-732d-4adf-bede-f4ad15d9e8a3",
      "attributes": { "status": "cancelled" }
    }
  }'

Attribute	Required	Description
`data.type`	Yes	`e-mandates`
`data.id`	Yes	The `emandate_id`, same as in the path.
`data.attributes.status`	Yes	`cancelled`, `revoked` or `draft`.

A change to cancelled or revoked triggers the matching webhook.

Errors

Status	Code	Cause
`400`	`INVALID_STATUS`	The status cannot be set through the API.
`400`	`EMANDATE_NOT_RESTARTABLE`	You asked for `draft` on an e-mandate that is no longer `draft`.
`404`	`INCORRECT_EMANDATE_ID`	No e-mandate with this identifier for your account.
`409`	`INVALID_STATUS_TRANSITION`	The e-mandate's current status does not allow this change, for example revoking a `draft`.