Get Balance Details

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

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.

Responses

200

OK

application/json

Schema

Schema

available_balancenumber
The balance available for any transaction or immediate use.
Example: 1000.5
incoming_balancenumber
Funds from payments that are in transit and not yet available for spending.
Example: 500.25
outgoing_balancenumber
Amounts earmarked for pending transactions, such as refunds or payouts, that will reduce the available balance once processed.
Example: 250.75
rolling_reserve_balancenumber
A reserve amount held for potential liabilities, such as chargebacks; may vary based on business risk.
Example: 1500
withdrawable_balancenumber
The amount eligible for withdrawal, excluding any rolling reserve amounts.
Example: 850.3

Example (auto)

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

400

Bad Request

401

Unauthorized

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

ResponseClear

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