Cancel a Mandate
POST {{url}}/mandates/{{mandate}}/actions/cancel
Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.
This will fail with a cancellation_failed error if the mandate is already cancelled.
Request Body
{"mandates"=>{"metadata"=>{"key"=>"value"}}}
RESPONSES
status: OK
{"mandates":{"id":"MD000ZS5BZ7YR8","created_at":"2024-03-22T20:38:06.178Z","reference":"QR9TV3T","status":"cancelled","scheme":"bacs","next_possible_charge_date":null,"payments_require_approval":false,"metadata":{"key":"value"},"links":{"customer_bank_account":"BA000ZP5QZBAMM","creditor":"CR00006C6DF0TD","customer":"CU0014DQHSRWPC"},"consent_parameters":null,"verified_at":null,"funds_settlement":"managed"}}