GET
/
v1
/
financial-accounts
/
{id}
Retrieve Financial Account
curl --request GET \
  --url https://api.monime.io/v1/financial-accounts/{id} \
  --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": {}
  }
}

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

Path Parameters

​
id
string
required

Unique identifier of the financial account to retrieve.

Query Parameters

​
withBalance
boolean

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

Response

200 - application/json

OK

The response is of type object.