HTTP Request
GET
/v1/balance/historyAuth: Signed API key required
Permissions: UserData
Signed Location: Query string
Get paginated balance history with filters for time, business, and amount.
Headers
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| X-MBX-APIKEY | true | string | Provisioned ACCESS_ID. x-access-id is also accepted by the backend, but X-MBX-APIKEY is recommended. |
Request Parameters
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| page | false | integer | Current page; default is controlled by the server. |
| limit | false | integer | Number of records per page. |
| currency | false | string | Filter by currency. |
| business | false | string | BalanceBusinessEnum. |
| amount | false | string | Exact amount to filter by. |
| start_time | false | int64 | Start Unix timestamp. |
| end_time | false | int64 | End Unix timestamp. |
| time_enum | false | string | Only supports Today or Yesterday. |
| timestamp | true | int64 | Request timestamp in milliseconds. Microseconds are also accepted and normalized by the server. |
| recvWindow | false | integer | Optional receive window. Default 5000, maximum 60000. |
| signature | true | string | HMAC-SHA256 signature of the signed payload. RSA and Ed25519 are also supported when provisioned. |
Return Parameters
| Parameter Name | Required | Type | Notes |
|---|---|---|---|
| data.data[] | true | array | Balance history rows. |
| data.count | true | integer | Number of items on the current page. |
| data.curr_page | true | integer | Current page number. |
| data.total | true | integer | Total number of records. |
| data.has_next | true | boolean | Whether there is a next page. |
| data.total_page | true | integer | Total number of pages. |
Request Example
curl 'https://<host>/v1/balance/history?page=1&limit=20¤cy=NGN×tamp=<TIMESTAMP>&recvWindow=5000&signature=<SIGNATURE>' \
-H 'X-MBX-APIKEY: <ACCESS_ID>'