GoCardless API API Documentation
Create a Creditor Bank Account
POST {{url}}/creditor_bank_accounts
Creates a new creditor bank account object. Note: Creditor bank accounts can be created with local or international bank details. You can find the different local bank detail formats, and how they should be used with the GoCardless API here.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"creditor_bank_accounts": {
"id": "BA000ZP65KHX04",
"created_at": "2024-03-22T21:46:27.780Z",
"account_number_ending": "44",
"account_holder_name": "HOME LOAN ACCOUNT",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {},
"enabled": true,
"links": {
"creditor": "CR00007SRS79RW"
},
"verification_status": "successful"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/creditor_bank_accounts' -d '{"creditor_bank_accounts":{"account_number":"55779944","branch_code":"200000","country_code":"GB","account_holder_name":"$randomBankAccountName","links":{"creditor":"$randomBankAccountName"}}}'
ENDPOINTS