List internal accounts

get

https://sandbox.numeral.io/v1/internal_accounts

List and filter internal accounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

0 to 100

Defaults to 25

starting_after

uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

The creation date of the internal account.

end_date

date

The creation date of the internal account.

connected_account_id

uuid

The ID of the connected account to which the virtual account refers.

name

string

length ≤ 100

The name of the internal account.

type

string

enum

The type of the internal account.

Allowed:

account_number

string

The account number of the internal account.

bank_code

string

The bank code of the internal account.

creditor_identifier

string

The creditor identifier of the internal account.

account_holder_id

uuid

The ID of the account holder to which the internal account refers to.

holder_name

string

length ≤ 100

The account holder name to look for. Searches through the holder_name and alternative_holder_names attributes.

status

string

enum

If disabled, only disabled internal accounts will be fetched.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200200

400Validation Error.