Hello Clever Developer Docs

GET

balances

history

Get Balance History V2

curl --request GET \
  --url https://api.cleverhub.co/api/v2/balances/history \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/balances/history"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/balances/history', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v2/balances/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cleverhub.co/api/v2/balances/history"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/balances/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "from_date": "2026-01-01T00:00:00Z",
  "to_date": "2026-01-31T00:00:00Z",
  "account_type": "aggregated",
  "size": 20,
  "next_cursor": "eyJpZCI6ImJsX3BpX3duNFRXaGxYQnJaSyJ9",
  "has_more": true,
  "records": [
    {
      "id": "bl_pi_wn4TWhlXBrZK",
      "amount": 202.66,
      "request_type": "money_out",
      "transaction_type": "settlement",
      "currency": "AUD",
      "payment_method": "bsb",
      "status": "done",
      "reference_id": "BAL_cqxDHqDOSs8=--4",
      "balance_detail": {
        "outgoing": 205,
        "total": 202.66,
        "fees": 2.34
      },
      "created_at": "2026-01-01T00:00:00.000+0000"
    }
  ]
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "message": "from date not valid"
  }
}

Authorizations

app-id

string

header

required

A unique identifier assigned to each application.

secret-key

string

header

required

A secure token associated with the app-id.

Query Parameters

from_date

string<date-time>

required

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

to_date

string<date-time>

required

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

cursor

string

Pagination cursor returned as next_cursor in the previous response. Omit this parameter to fetch the first page.

size

integer

default:20

Number of records to return per page.

Response

from_date

string

Example:

"2026-01-01T00:00:00Z"

to_date

string

Example:

"2026-01-31T00:00:00Z"

account_type

enum<string>

The type of the requesting account.

Available options:

aggregated,

dedicated

Example:

"aggregated"

size

integer

Number of records returned per page.

Example:

20

next_cursor

string | null

Cursor to pass as the cursor query parameter to fetch the next page. null when there are no more records.

Example:

"eyJpZCI6ImJsX3BpX3duNFRXaGxYQnJaSyJ9"

has_more

boolean

Whether more records are available after this page.

Example:

true

records

object[]

Show child attributes

⌘I

Get Balance History V2

curl --request GET \
  --url https://api.cleverhub.co/api/v2/balances/history \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/balances/history"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/balances/history', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v2/balances/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cleverhub.co/api/v2/balances/history"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/balances/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "from_date": "2026-01-01T00:00:00Z",
  "to_date": "2026-01-31T00:00:00Z",
  "account_type": "aggregated",
  "size": 20,
  "next_cursor": "eyJpZCI6ImJsX3BpX3duNFRXaGxYQnJaSyJ9",
  "has_more": true,
  "records": [
    {
      "id": "bl_pi_wn4TWhlXBrZK",
      "amount": 202.66,
      "request_type": "money_out",
      "transaction_type": "settlement",
      "currency": "AUD",
      "payment_method": "bsb",
      "status": "done",
      "reference_id": "BAL_cqxDHqDOSs8=--4",
      "balance_detail": {
        "outgoing": 205,
        "total": 202.66,
        "fees": 2.34
      },
      "created_at": "2026-01-01T00:00:00.000+0000"
    }
  ]
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "message": "from date not valid"
  }
}

Basics

Payment Gateway (AUD)

Multi-Currency Payment API

Payment Gateway 3

Card API

Cashback API

Get Balance History V2

Authorizations

Query Parameters

Response