Balance

Get Balance Details

Retrieve detailed information on the various balance types available for transactions in your account. This API provides insights into different balances, which help in tracking funds across distinct states. The following balance types are included:

available_balance: The amount currently available for any transaction, representing funds that can be used immediately.
incoming_balance: Funds that are in the process of being credited from successful payments but are yet to be paid out by the third-party provider (e.g., credit card processor).
outgoing_balance: Funds that are pending deduction from the available balance, set aside to process future actions such as refunds, disputes, or payouts.
rolling_reserve_balance: A reserved amount held as a buffer by the merchant; typically used for security against chargebacks or other potential liabilities. This is an optional feature that can be activated by contacting technical support.
withdrawable_balance: The portion of the available balance that can be withdrawn, which excludes rolling reserve funds.

Note: This API currently supports only AUD (Australian Dollar) balances. Support for additional currencies is under development.

GET

balances

detail

Get Balance Details

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

import requests

url = "https://api.cleverhub.co/api/v1/balances/detail"

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/v1/balances/detail', 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/v1/balances/detail",
  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/v1/balances/detail"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/balances/detail")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/balances/detail")

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

{
  "available_balance": 1000.5,
  "incoming_balance": 500.25,
  "outgoing_balance": 250.75,
  "rolling_reserve_balance": 1500,
  "withdrawable_balance": 850.3
}

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.

Response

available_balance

number

The balance available for any transaction or immediate use.

Example:

1000.5

incoming_balance

number

Funds from payments that are in transit and not yet available for spending.

Example:

500.25

outgoing_balance

number

Amounts earmarked for pending transactions, such as refunds or payouts, that will reduce the available balance once processed.

Example:

250.75

rolling_reserve_balance

number

A reserve amount held for potential liabilities, such as chargebacks; may vary based on business risk.

Example:

1500

withdrawable_balance

number

The amount eligible for withdrawal, excluding any rolling reserve amounts.

Example:

850.3

Payment APIs for AUD (v1)

Get Balance History

Get Balance Details

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

import requests

url = "https://api.cleverhub.co/api/v1/balances/detail"

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/v1/balances/detail', 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/v1/balances/detail",
  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/v1/balances/detail"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/balances/detail")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/balances/detail")

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

{
  "available_balance": 1000.5,
  "incoming_balance": 500.25,
  "outgoing_balance": 250.75,
  "rolling_reserve_balance": 1500,
  "withdrawable_balance": 850.3
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Get Balance Details

Authorizations

Response