GOgocardless
Mandate Import

Submit a mandate import

Submits the mandate import, which allows it to be processed by a member of the GoCardless team. Once the import has been submitted, it can no longer have entries added to it.

In our sandbox environment, to aid development, we automatically process mandate imports approximately 10 seconds after they are submitted. This will allow you to test both the "submitted" response and wait for the webhook to confirm the processing has begun.

post/mandate_imports/{mandate_import_id}/actions/submit

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.