GET
/
v1
/
financial-accounts
List Financial Accounts
curl --request GET \
  --url https://api.monime.io/v1/financial-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": [
    {
      "id": "<string>",
      "uvan": "<string>",
      "name": "<string>",
      "currency": "<string>",
      "reference": "<string>",
      "description": "<string>",
      "balance": {
        "available": {
          "currency": "<string>",
          "value": 123
        }
      },
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "count": 123,
    "next": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Monime-Space-Id
string
required

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

Maximum length: 64

Query Parameters

​
uvan
string | null

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

Maximum length: 16
​
reference
string | null

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

Maximum length: 64
​
withBalance
boolean

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

​
limit
integer
default:10

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

Required range: 1 <= x <= 50
​
after
string | null

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

Maximum length: 2000

Response

200 - application/json

OK

The response is of type object.