GOgocardless
Mandate Import Entry

Add a mandate import entry

For an existing mandate import, this endpoint can be used to add individual mandates to be imported into GoCardless.

You can add no more than 30,000 rows to a single mandate import. If you attempt to go over this limit, the API will return a record_limit_exceeded error.

post/mandate_import_entries

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "mandate_import_entries": {
    "links": {
      "mandate_import": "IM123"
    },
    "record_identifier": "bank-file.xml/line-1",
    "mandate": {
      "reference": "REF-123"
    },
    "customer": {
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "email": "user@example.com",
      "language": "en",
      "address_line2": "Marylebone",
      "address_line3": "City of Westminster",
      "city": "London",
      "region": "Greater London",
      "country_code": "GB",
      "phone_number": "+64 4 817 9999",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "2205506218"
    },
    "bank_account": {
      "account_holder_name": "Billie Jean",
      "account_number": "55779911",
      "branch_code": "20-00-00",
      "country_code": "GB",
      "iban": "GB60BARC20000055779911",
      "account_type": "savings"
    },
    "amendment": {
      "original_mandate_reference": "REFNMANDATE",
      "original_creditor_id": "FR123OTHERBANK",
      "original_creditor_name": "Existing DD Provider"
    }
  }
}

Response

Resource created successfully

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"
    }
  }
}

Changes

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