GoCardless API API Documentation
Cancel Mandate Import
POST {{url}}/mandate_imports/{{mandate_import}}/actions/cancel
Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless. Once the import has been cancelled, it can no longer have entries added to it. Mandate imports which have already been submitted or processed cannot be cancelled.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"mandate_imports": {
"id": "IM00002PBRXKXR",
"scheme": "bacs",
"status": "cancelled",
"created_at": "2024-03-22T20:34:39.897Z",
"links": {
"creditor": "CR00006C6DF0TD"
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/mandate_imports/https://api-sandbox.gocardless.com/actions/cancel'
ENDPOINTS