GOgocardless
Mandate Import Entry

List all mandate import entries

For an existing mandate import, this endpoint lists all of the entries attached.

After a mandate import has been submitted, you can use this endpoint to associate records in your system (using the record_identifier that you provided when creating the mandate import).

get/mandate_import_entries

Request

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

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

mandate_importstring required

Unique identifier, beginning with "IM".

Example:IM123
status'successfully_processed' | 'unsuccessfully_processed'

One of:

  • successfully_processed: the entry has been imported and the associated records created.
  • unsuccessfully_processed: the entry could not be processed due to an error, see the 'processing_errors' value
Example:successfully_processed

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "mandate_import_entries": [
    {
      "record_identifier": "bank-file.xml/line-1",
      "created_at": "2014-01-01T12:00:00.000Z",
      "links": {
        "mandate_import": "IM0000AAAAAAA",
        "mandate": "MD123",
        "customer": "CU123",
        "customer_bank_account": "BA123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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