Get Balance Details V2

GET 
https://api.cleverhub.co/api/v2/balances/detail

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.

Request

Query Parameters

currency string
Possible values: [AUD, PHP, USD, KRW, MYR, IDR, VND, JPY, USDC, CAD, NGN, ZAR, KES, GHS, XAF, XOF, BRL, THB]
The currency of the balance. If not provided, the default currency will be 'AUD'
Default value: AUD

Responses

200

OK

application/json

Schema

Schema

available_balancenumberrequired
The balance available for all transactions.
Example: 1000
incoming_balancenumberrequired
The balance shows successful payments but the 3rd party device has not yet paid for it.
Example: 1000
outgoing_balancenumberrequired
The balance being transferred is waiting to be taken from the available balance to process actions.
Example: 1000
rolling_reserve_balancenumberrequired
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_balancenumberrequired
The amount you can withdraw excludes rolling reserves.
Example: 1000

Example (auto)

{
  "available_balance": 1000,
  "incoming_balance": 1000,
  "outgoing_balance": 1000,
  "rolling_reserve_balance": 1000,
  "withdrawable_balance": 1000
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

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

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• 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/v2/balances/detail");
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

currency — query

---AUDPHPUSDKRWMYRIDRVNDJPYUSDCCADNGNZARKESGHSXAFXOFBRLTHB

ResponseClear

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