List accounts

accounts

GET

/api/v1/accounts

Retrieves a list of accounts.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

limit

The page size, indicating the number of entries returned per page.

Type

integer

Default

20

Minimum

1

Maximum

100

page

This is the page number.

Type

integer

Example1

Minimum

1

Default

1

accountIdentifier.type

Type

string

Valid values

"ID""IBAN"

accountIdentifier.value

The exact account number or IBAN of the counterparty to retrieve.

Type

string

Min Length

1

Max Length

34

Pattern

"^[A-Z0-9]+$"

branchIdentifier.type

Field to identify the branch identifier.

Type

string

Valid values

"BIC""IFSC""SORT""ROUTING"

branchIdentifier.value

Branch identifier for the debtor account.

Type

string

Min Length

1

Max Length

11

Pattern

"^[A-Z0-9]+$"

Responses

Successfully retrieved list of accounts.

Content-Type

application/json

object

object

Required

This is the page number.

Minimum0

The page size, indicating the number of entries returned per page.

Minimum0

true if there are more pages available beyond this one.

object[]

Required

The account name of the legal entity as per the bank record.

The account name of the legal entity as per the bank record.

This field is used to identify the type of account. Currently only BANK_ACCOUNT is supported.

Valid values"BANK_ACCOUNT"

The country of the bank as the 2-letter ISO 3166 code. This is mandatory only if accountType is BANK-ACCOUNT.

Min Length2

Max Length2

Pattern"^[A-Z]{2}$"

The name of the Bank that holds the Corporate accounts. This is mandatory only if accountType is BANK-ACCOUNT.

The category of counterparty account.
Possible values: PERSONAL or BUSINESS

Valid values"PERSONAL""BUSINESS"

The 3-letter ISO 4217 currency code. Supported values: EUR, USD, GBP. This determines the settlement currency and applicable regional payment rails.

Valid values"EUR""USD""GBP"

object

Required

object

Possible values: [ACTIVE, INACTIVE]
indicates the state of the account.

Valid values"ACTIVE""INACTIVE"

This field lists the products associated with the account.

The date and time the account link was created in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

Format"date-time"

Pattern"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$"

The date and time the account link was updated in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

Format"date-time"

Pattern"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$"