Mandate Import

Create a new mandate import

Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process. Once you've finished adding entries to an import, you should submit it.

post/mandate_imports

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "mandate_imports": {
    "scheme": "bacs",
    "links": {
      "creditor": "CR123"
    }
  }
}

Response

Resource created 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.