Get Balance History

GET 
https://api.cleverhub.co/api/v1/balances/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.

Request

Query Parameters

from_date date-time

Start date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.

to_date date-time

End date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.

page integer

The page number of the balance history results, for pagination purposes.

size integer

Number of records to display per page in the paginated response.

Responses

200

OK

application/json

Schema

Schema

from_datedate-time
The start date for the balance history retrieved.
Example: 2022-01-01T00:00:00Z
to_datedate-time
The end date for the balance history retrieved.
Example: 2022-01-31T23:59:59Z
pageinteger
The current page number of the response.
Example: 1
sizeinteger
The number of records returned per page.
Example: 20
next_pageinteger
The page number of the next set of results, if available.
Example: 2
total_pageinteger
The total number of pages in the response.
Example: 10
total_countinteger
The total number of records available across all pages.
Example: 200
records object[]
Array [
idstring
Unique identifier for the balance transaction.
Example: txn_01F8R97A2P9A9
amountnumber
The amount associated with the transaction.
Example: 150.75
request_typestring
Type of transaction, indicating if funds are being credited or debited.
Possible values: [money_out, money_in]
Example: money_in
transaction_typestring
The specific type of transaction affecting the balance.
Possible values: [payment, settlement, refund, topup, dispute, eod_settlement, dispute_fee, payout, payout_refund]
Example: payment
currencystring
Currency code for the transaction.
Example: AUD
payment_methodstring
Method used for the transaction.
Possible values: [bsb, card, pay_id, pay_to]
Example: card
statusstring
Status of the transaction.
Possible values: [waiting, done, failed]
Example: done
reference_idstring
A unique reference identifier for the transaction.
Example: ref_01F8R97A2P9A9
balance_detail object
outgoingnumber
Amount being deducted or processed in the transaction.
Example: 120
totalnumber
Total transaction amount, which may include fees.
Example: 130
feesnumber
Fees applied to the transaction.
Example: 10
created_atdate-time
The timestamp indicating when the transaction was created (UTC).
Example: 2022-01-15T12:30:00Z
]

Example (auto)

{
  "from_date": "2022-01-01T00:00:00Z",
  "to_date": "2022-01-31T23:59:59Z",
  "page": 1,
  "size": 20,
  "next_page": 2,
  "total_page": 10,
  "total_count": 200,
  "records": [
    {
      "id": "txn_01F8R97A2P9A9",
      "amount": 150.75,
      "request_type": "money_in",
      "transaction_type": "payment",
      "currency": "AUD",
      "payment_method": "card",
      "status": "done",
      "reference_id": "ref_01F8R97A2P9A9",
      "balance_detail": {
        "outgoing": 120,
        "total": 130,
        "fees": 10
      },
      "created_at": "2022-01-15T12:30:00Z"
    }
  ]
}

400

Bad Request

401

Unauthorized

422

Unprocessable Entity

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v1/balances/history");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

from_date — query

to_date — query

page — query

size — query

ResponseClear

Click the Send API Request button above and see the response here!