GOgocardless
Mandate Import

Cancel a mandate import

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.

post/mandate_imports/{mandate_import_id}/actions/cancel

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

mandate_import_idstring required

The mandate import id

Headers

GoCardless-Versionstring required

Request body

mandate_importsobject

Response

Action completed successfully

Example response

{
  "mandate_imports": {
    "id": "IM123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "status": "created",
    "scheme": "bacs",
    "links": {
      "creditor": "CR123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.