Add Bank Accounts
POST {{base_url}}/banking/v2/accounts
This endpoint can be used to manually import bank accounts and link them to a company.
Attributes
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| currency | string | Account currency |
| nickname | string | Nickname |
| account | JSON object | Account information |
| account -> schemename | string | IBAN or Account and sort code |
| account -> identification | string | Unique id per bank account |
| account -> name | string | Account name |
| account -> secondaryIdentification | string | Any optional extra information about account |
| externalId | string | An Id linked to an external source |
Error Messages
| Condition | Response Status | Response Body |
|---|
| No request body | 400 Bad Request | { error : "Missing/invalid JSON” } |
| Missing/invalid currency | 403 Forbidden | { error : "Missing/invalid currency” } |
| Missing/Invalid bankId | 404 Not Found | { error : "Missing/invalid bankId” } |
Request Body
{"values"=>[{"bankId"=>6, "currency"=>"GBP", "nickname"=>"Business Account", "account"=>[{"schemeName"=>"IBAN", "identification"=>"GB84BANKIDENTIFICATION", "secondaryIdentification"=>"POS", "name"=>"Debit Account"}], "externalId"=>"BANK_NAME_ID"}]}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |