Create a new account.

post

https://example.com/accounts/private/v1/accounts

For admin and client expects different request body, check schemas. For admin: not allowed if admin has no "create_accounts" permission. Also admin need "create_accounts_with_initial_balance" permission to create account with not zero balance.

List of possible error codes:

Code	Status	Target	Description
ACCOUNT_EXISTS_FOR_TYPE	400	common	Current user already have account of selected type

Body Params

For creation by admin

number

string

length ≥ 28

should contains alphanumeric characters only.

typeId

number

required

The ID of the account type.

userId

string

required

The ID of an existing user.

description

string

Additional description or details about the account.

isActive

boolean

Indicates whether the account is active or not.

initialBalance

string

The initial balance of the account.

allowWithdrawals

boolean

Indicates whether withdrawals are allowed for the account.

allowDeposits

boolean

Indicates whether deposits are allowed for the account.

maturityDate

string

The maturity date of the account.

payoutDay

number

The day of the month on which the account payout occurs.

interestAccountId

number

The ID of the interest account where the payout should be transferred

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful request

400Bad Request

403Forbidden