Create a new account type as an admin.

post

https://example.com/accounts/private/v1/account-types

Not allowed if admin has no "modify_account_types" permission.

NOTE: “Line of credit” and “Interest generation” can’t be selected at the same time. All other options are available to combine.

Body Params

name

string

The name of the account type. Should contain alphanumeric characters only.

currencyCode

string

The currency code of the account type. Must be a code of an active currency.

autoNumberGeneration

boolean

Indicates whether the account type supports automatic number generation.

isNumberPrefix

boolean

Indicates whether the account type uses a number prefix.

numberPrefix

string

The prefix used for account numbers.

isMinimumBalance

boolean

Indicates whether the account type enforces a minimum balance.

balanceFeeAmount

number

The amount of fee for minimum balance.

balanceChargeDay

integer

The day of the month for charging account balance.

balanceLimitAmount

number

The limit amount for account balance.

isLineOfCredit

boolean

Indicates whether the account type is a line of credit.

creditLimitAmount

number

The credit limit amount for the line of credit account.

creditAnnualInterestRate

number

The annual interest rate for the line of credit account.

creditPayoutMethodId

integer

The ID of the payout method for the line of credit account.

creditChargePeriodId

integer

The ID of the charge period for the line of credit account.

creditChargeDay

integer

1 to 31

The day of the month for charging the line of credit account.

creditChargeMonth

integer

1 to 12

The month for charging the line of credit account.

IsMonthlyMaintenance

boolean

Indicates whether the account type has a monthly maintenance fee.

monthlyMaintenanceFee

number

The monthly maintenance fee amount for the account type.

isDeposit

boolean

Indicates whether the account type is a deposit account.

depositAnnualInterestRate

number

The annual interest rate for the deposit account.

depositPayoutMethodId

integer

The ID of the payout method for the deposit account.

depositPayoutPeriodId

integer

The ID of the payout period for the deposit account.

depositPayoutDay

integer

1 to 31

The day of the month for the deposit account payout.

depositPayoutMonth

integer

1 to 12

The month for the deposit account payout.

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