Get list of account types

get

https://localhost/business-users/private/v1/short-account-types

Retrieves a paginated list of account types with support for filtering, sorting, and field selection.
This endpoint supports the same query parameters as the accounts service account-types endpoint.

Query Params

filter[name]

string

Filter account types by name (partial match).

Example: Savings

filter[currencyType]

string

Filter account types by currency type.

Available values: [fiat, crypto].

Example: fiat

sort

string

Sort results by field. Prefix with '-' for descending order.

Available fields: [id, name, currencyCode, annualInterestRate, period.name].

Example: -name or id

page

integer

Page number for pagination (default 1).

Example: 2

limit

integer

Number of items per page (default 10).

Example: 20

fields

string

Comma-separated list of fields to include in response.

Available fields: [ID, Name, CurrencyCode, CurrencyType, DepositAnnualInterestRate, CreditAnnualInterestRate, DepositPayoutPeriodID, AutoNumberGeneration, NumberPrefix].

Example: ID,Name,CurrencyCode

include

string

Include related resources.

Available includes: [depositPayoutPeriod, creditChargePeriod].

Example: depositPayoutPeriod

Responses

200Account types retrieved successfully with pagination

400The request is invalid - invalid query parameters

500The server cannot process the request