API reference
Balance
Read your payout balance.
Get the balance
GET/api/v1/balancescope
balance.readYour payout balance. Available is what you can pay out now; reserved is locked in approved batches; pending is expected but not yet credited.
GET /api/v1/balance · test
curl -X GET "https://api.tranzaq.com/api/v1/balance" \
-H "Authorization: Bearer $TOKEN"const response = await fetch("https://api.tranzaq.com/api/v1/balance", {
method: "GET",
headers: {
Authorization: `Bearer ${token}`,
},
});
console.log(await response.json());var request = new HttpRequestMessage(HttpMethod.Get, "/api/v1/balance");
request.Headers.Authorization = new("Bearer", token);
var response = await http.SendAsync(request); // http.BaseAddress = "https://api.tranzaq.com"
Console.WriteLine(await response.Content.ReadAsStringAsync());import uuid, requests
response = requests.get(
"https://api.tranzaq.com/api/v1/balance",
headers={"Authorization": f"Bearer {token}"},
)
print(response.json())Answer · 200
Response · test
{
"success": true,
"message": "Operation completed",
"code": 200,
"result": {
"available": 75449.74,
"reserved": 0.00,
"pending": 0.00,
"total": 75449.74,
"currency": "GHS",
"asOf": "2026-10-18T10:20:00+00:00"
}
}Errors
- 401Missing, invalid or expired token.
- 403The token does not have the balance.read scope.