Logo
GoCardless API API Documentation

Reinstate a Mandate

POST {{url}}/mandates/{{mandate}}/actions/reinstate

Reinstates a cancelled or expired mandate to the banks. You will receive a resubmissionrequested webhook, but after that reinstating the mandate follows the same process as its initial creation, so you will receive a submitted webhook, followed by a reinstated or failed webhook up to two working days later. Any metadata supplied to this endpoint will be stored on the resubmissionrequested event it causes.

This will fail with a mandatenotinactive error if the mandate is already being submitted, or is active.

Mandates can be resubmitted up to 10 times.

Reinstate a mandate API docs

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "mandates": { "id": "MD000ZS5BZ7YR8", "created_at": "2024-03-22T20:38:06.178Z", "reference": "QR9TV3T", "status": "pending_submission", "scheme": "bacs", "next_possible_charge_date": "2024-04-02", "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" } }



Curl
curl -X POST 'https://api-sandbox.gocardless.com/mandates/mandate/actions/reinstate' -d '{"mandates":{"metadata":{"key":"value"}}}'

ENDPOINTS