Mandate
Reinstate a mandate
<a name="mandate_not_inactive"></a>Reinstates a cancelled or expired mandate to the banks. You will receive a resubmission_requested 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 resubmission_requested event it causes.
This will fail with a mandate_not_inactive error if the mandate is already being submitted, or is active.
Mandates can be resubmitted up to 10 times.
<p class="restricted-notice"><strong>Restricted</strong>: this endpoint requires approved [custom payment pages](https://support.gocardless.com/hc/en-gb/articles/115004521925-Custom-Payment-Pages). To instead use the GoCardless hosted payment pages, see the [redirect flows](https://docs.gocardless.com/docs/api-reference/redirect-flow) endpoint.</p> <p class="notice--warning"><strong>Warning</strong>: A mandate can only be reinstated if it has been cancelled through the dashboard or the API. Any mandate that has been cancelled by the bank cannot be reinstated.</p>post/mandates/{mandate_id}/actions/reinstate
Request
- Base URLhttps://api.gocardless.com
- AuthHTTP bearer
Path parameters
mandate_idstring required
The mandate id
Headers
GoCardless-Versionstring required
Request body
Response
Action completed successfully
Example response
{
"mandates": {
"id": "MD123",
"created_at": "2014-01-01T12:00:00.000Z",
"reference": "REF-123",
"status": "pending_submission",
"scheme": "bacs",
"mandate_type": "bank_debit",
"next_possible_charge_date": "2014-10-27",
"next_possible_standard_ach_charge_date": "2014-10-27",
"verified_at": "2021-01-01T12:00:00.000Z",
"links": {
"customer_bank_account": "BA123",
"creditor": "CR123",
"new_mandate": "MD123",
"customer": "CU123"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.