GoCardless API API Documentation
Add Mandate import Entry
POST {{url}}/mandate_import_entries
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 recordlimitexceeded error.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"mandate_import_entries": {
"record_identifier": "bank-file.xml/line-354",
"links": {
"mandate_import": "IM00002R3276AR"
},
"created_at": "2024-08-07T14:38:05.838Z"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/mandate_import_entries' -d '{"mandate_import_entries":{"links":{"mandate_import":"mandate_import"},"record_identifier":"bank-file.xml/line-$randomInt","customer":{"company_name":"$randomCompanyName","given_name":"$randomFirstName","family_name":"$randomLastName","email":"$randomExampleEmail","address_line1":"$randomStreetAddress","city":"$randomCity","postal_code":"E8 3GX","country_code":"GB","metadata":{"customer_id":"customer123"}},"bank_account":{"account_holder_name":"Jane Doe","account_number":"55779911","branch_code":"200000","metadata":{"customer_id":"customer123"}},"mandate":{"metadata":{"customer_id":"customer123"}}}}'
ENDPOINTS