Account Details

Last updated August 15th, 2025

get api.withmono.com/v2/accounts/{id}
v1.0

This resource represents the account details with the financial institution.

Upcoming Changes: Effective September 15, 2025

We're introducing new data status definitions and response structures to provide better transparency and control when syncing data. These updates apply to all Mono APIs and webhook responses where account data is involved.

1.) New Data Statuses

We are introducing two new data_status values and changing the definition of one existing value:

  • partial – Either balance or transactions was returned, but not both.
  • unavailable – Balance and transactions were not returned, due to issues from the bank or the user has no data available.

Field Change Definition

  • failed - Balance and transactions were not returned due to an issue from Mono’s system only (e.g. internal service errors, timeouts, system outages).

2.) Updated ‘meta’ object in this Endpoint

This endpoint will now consistently include a retrieved_data array in the meta object for all statuses. This gives you visibility into what was actually fetched.

Example:

Request

12345
"meta": {
  "data_status": "AVAILABLE",
  "auth_method": "internet_banking",
  "retrieved_data": ["balance", "transactions"]
}
Real-time Data

Real-time Data

Real-time account balance is returned when x-real-time in your headers is set to true.

Currency

Currency

The currency returned in each country:

NGN KOBO

GHC PESEWA

KSH CENTS

ZAR CENTS

BVN (Nigeria only)

BVN (Nigeria only)

Please note that the last 4 digits of the BVN get returned on this API. To get the full BVN, please call our Identity API to get full BVN information.

Data status

Data status

If the meta data_status is still in the processing stage, you have to wait before calling the APIs below e.g Statement, Transaction, Income and Identity Endpoints.

Some banks are faster than others, so it may be available instantly after authorization and some banks might take a few seconds or minutes.

Path Params
Headers

Request

1234
curl --request GET \
  --url https://api.withmono.com/v2/accounts/id \
  --header 'mono-sec-key: string' \
  --header 'accept: application/json'

Response

Choose an option from the drop down or click one of these buttons to see an example:

Did this page help you?