Balances
Your balance shows how much money is ready to be paid out and how much is still pending. Use it to power finance dashboards, decide when to schedule a payout, and understand the current state of funds collected through Inttegro.
The response is a point-in-time snapshot rather than a live transaction list. Check includes_transactions_before to see when the snapshot ends, and use Balance transactions when you need the individual payments and refunds behind it.
Operations
The balance object
Balances are grouped by currency. Every amount uses that currency's smallest unit, such as pesewas for GHS.
available is the amount you can use for a payout. pending contains funds that have been collected but are not available yet. The snapshot also reports its reserved and refund amounts and the cutoff through which balance activity has been included.
Properties
Retrieve your balance
Retrieve your latest GHS balance snapshot. Read available.amount to see how much can be paid out, and keep includes_transactions_before with the result when reconciling it against balance transactions.
A new account with no completed balance activity returns a zero-valued GHS snapshot.
AI clients can use get_balances for this operation. MCP read tools return minimized business data and do not change Inttegro state.
Request body
Send an empty JSON object. No balance ID or other request attributes are needed.
Request
- cURL
- TypeScript
- Go
- Python
- PHP
- Ruby
- Java
- C#
curl https://api.inttegro.com/balances \
-H "Authorization: Bearer $INTTEGRO_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
import * as Inttegro from '@inttegro/inttegro-sdk'
const inttegro = new Inttegro.InttegroClient({
apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.balances.get()
package main
import (
"context"
"log"
"os"
inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)
func main() {
ctx := context.Background()
client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))
result, err := client.Balances.Get(ctx)
if err != nil {
log.Fatal(err)
}
_ = result
}
import os
import inttegro
client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.balances.get()
<?php
use Inttegro\Client;
$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->balances->get();
require "inttegro"
client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.balances.get
import com.inttegro.Client;
public class Example {
public static void main(String[] args) throws Exception {
var client = new Client(System.getenv("INTTEGRO_API_KEY"));
var result = client.balances().get();
}
}
using Inttegro;
using var inttegro = new InttegroClient(
Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.Balances.GetAsync();
Related resources
- Understand balances - Learn how available and pending funds change over time.
- Balance transactions - Inspect the entries behind a balance.
- Payouts - Move available funds to a financial account.
- Understand payout settings - Configure when automatic payouts run.