v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Financial Account

List Financial Accounts

Retrieves list of financial accounts.

get/v1/financial-accounts

Query parameters

uvanstring nullable

Filter by Universal Virtual Account Number (UVAN), a unique alias for the financial account.

Filter by Universal Virtual Account Number (UVAN), a unique alias for the financial account.

referencestring nullable

Filter by external reference ID used to link the account with your internal system.

Filter by external reference ID used to link the account with your internal system.

withBalanceboolean

If true, includes the balance of the financial accounts in the response.

If true, includes the balance of the financial accounts in the response.

limitinteger

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

afterstring nullable

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Headers

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Specifies which version of the Monime API will handle this request.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true