Get Balance History
Access a detailed history of balance transactions over a specified date range. This includes all balance changes in your account, such as incoming payments, refunds, top-ups, and other transactions. Use this endpoint to gain a comprehensive view of how balance values fluctuate due to account activity.
Note: This API currently supports only AUD (Australian Dollar) balances. Support for additional currencies is under development.
Authorizations
A unique identifier assigned to each application.
A secure token associated with the app-id.
Query Parameters
Start date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.
"2022-01-01T00:00:00Z"
End date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.
"2022-01-31T23:59:59Z"
The page number of the balance history results, for pagination purposes.
Number of records to display per page in the paginated response.
Response
OK
The start date for the balance history retrieved.
"2022-01-01T00:00:00Z"
The end date for the balance history retrieved.
"2022-01-31T23:59:59Z"
The current page number of the response.
1
The number of records returned per page.
20
The page number of the next set of results, if available.
2
The total number of pages in the response.
10
The total number of records available across all pages.
200