Balance

Get Balance Details V2

There are 5 balance types:

available_balance: The balance available for all transactions.
incoming_balance: The balance shows successful payments but the 3rd party device has not yet paid for it (payment card).
outgoing_balance: The balance being transferred is waiting to be taken from the available balance to process actions (refund, dispute, payout).
rolling_reserve_balance: The floating amount a merchant keeps in their balance. Rolling reserve balance is not mandatory. The merchant can request to reserve balance by contacting tech support.
withdrawable_balance: The amount you can withdraw excludes rolling reserves.

GET

balances

detail

Get Balance Details V2

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

import requests

url = "https://api.cleverhub.co/api/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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,
  "incoming_balance": 1000,
  "outgoing_balance": 1000,
  "rolling_reserve_balance": 1000,
  "withdrawable_balance": 1000
}

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

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

currency

enum<string>

default:AUD

The currency of the balance. If not provided, the default currency will be 'AUD'

Available options:

AUD,

PHP,

USD,

KRW,

MYR,

IDR,

VND,

JPY,

USDC,

CAD,

NGN,

ZAR,

KES,

GHS,

XAF,

XOF,

BRL,

THB

Response

available_balance

number

required

The balance available for all transactions.

Example:

1000

incoming_balance

number

required

The balance shows successful payments but the 3rd party device has not yet paid for it.

Example:

1000

outgoing_balance

number

required

The balance being transferred is waiting to be taken from the available balance to process actions.

Example:

1000

rolling_reserve_balance

number

required

The floating amount a merchant keeps in their balance. Rolling reserve balance is not mandatory. The merchant can request to reserve balance by contacting tech support.

Example:

1000

withdrawable_balance

number

required

The amount you can withdraw excludes rolling reserves.

Example:

1000

Multi-Currency Payment API (v2)

Get Payin Methods

Get Balance Details V2

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

import requests

url = "https://api.cleverhub.co/api/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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,
  "incoming_balance": 1000,
  "outgoing_balance": 1000,
  "rolling_reserve_balance": 1000,
  "withdrawable_balance": 1000
}

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

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Get Balance Details V2

Authorizations

Query Parameters

Response