Skip to main content
POST
/
bank-accounts
Create bank account
curl --request POST \
  --url https://{host}/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "accountName": "Primary Current Account",
  "accountNumber": "GB29NWBK60161331926819",
  "bankName": "Acme Bank",
  "holderName": "Jane Doe"
}
'
{
  "id": "ba_64f0c51e7fb3fc001234abcd",
  "userId": "bank-user-12345",
  "accountName": "Primary Current Account",
  "accountNumber": "GB29NWBK60161331926819",
  "status": "active",
  "bankName": "Acme Bank",
  "holderName": "Jane Doe",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-user-id
string
required

The external user identifier of the acting customer.

Example:

"bank-user-12345"

Body

application/json
​
accountName
string
required
Example:

"Primary Current Account"

​
accountNumber
string
required

IBAN or local account identifier

Example:

"GB29NWBK60161331926819"

​
bankName
string
Example:

"Acme Bank"

​
holderName
string
Example:

"Jane Doe"

Response

Bank account created

​
id
string
required
Example:

"ba_64f0c51e7fb3fc001234abcd"

​
userId
string
required

Identifier of the user who owns this bank account

Example:

"bank-user-12345"

​
accountName
string
required
Example:

"Primary Current Account"

​
accountNumber
string
required

IBAN or local account identifier

Example:

"GB29NWBK60161331926819"

​
status
enum<string>
required

Status of the bank account

Available options:
pending_verification,
active,
disabled
Example:

"active"

​
bankName
string
Example:

"Acme Bank"

​
holderName
string
Example:

"Jane Doe"

​
createdAt
string<date-time>
​
updatedAt
string<date-time>