Get account balance
curl --request GET \
--url https://api.fyatu.com/api/v3.20/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3.20/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3.20/balance', 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.fyatu.com/api/v3.20/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.fyatu.com/api/v3.20/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.fyatu.com/api/v3.20/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3.20/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"status": 200,
"message": "Balance retrieved",
"data": {
"balance": 10000,
"currency": "USD",
"isLow": false,
"lowBalanceThreshold": 0,
"updatedAt": "2026-05-24T10:00:00Z"
},
"meta": {
"requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
"platform": "Fyatu CaaS",
"timestamp": "2026-05-24T10:00:00Z"
}
}Account
Account Balance
Retrieve the operational balance of your account — the working reserve for card issuance, JIT funding, and invoice payments. GET /balance. Requires accounts:read scope.
GET
/
balance
Get account balance
curl --request GET \
--url https://api.fyatu.com/api/v3.20/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3.20/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3.20/balance', 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.fyatu.com/api/v3.20/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.fyatu.com/api/v3.20/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.fyatu.com/api/v3.20/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3.20/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"status": 200,
"message": "Balance retrieved",
"data": {
"balance": 10000,
"currency": "USD",
"isLow": false,
"lowBalanceThreshold": 0,
"updatedAt": "2026-05-24T10:00:00Z"
},
"meta": {
"requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
"platform": "Fyatu CaaS",
"timestamp": "2026-05-24T10:00:00Z"
}
}Overview
Returns the operational balance of your CaaS account — the working reserve that funds all card-related operations:- Card issuance — every virtual card issued draws from this balance
- Card funding — loading funds onto a card debits this balance
- JIT funding — real-time authorisation funding is drawn at the moment of transaction
- Invoice payments — monthly platform fees are debited here when due
Example
curl https://api.fyatu.com/api/v3.20/balance \
-H "Authorization: Bearer $FYATU_API_KEY"
const resp = await fetch('https://api.fyatu.com/api/v3.20/balance', {
headers: { 'Authorization': `Bearer ${process.env.FYATU_API_KEY}` }
});
const { data } = await resp.json();
console.log(`Balance: ${data.balance} ${data.currency}`);
if (data.isLow) console.warn('Low balance — top up to avoid disruptions');
import os, requests
resp = requests.get(
'https://api.fyatu.com/api/v3.20/balance',
headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'}
)
data = resp.json()['data']
print(f"Balance: {data['balance']} {data['currency']}")
if data['isLow']:
print('Warning: balance is below your alert threshold')
Success Response (200)
{
"success": true,
"status": 200,
"message": "Balance retrieved",
"data": {
"balance": 10000.00,
"currency": "USD",
"isLow": false,
"lowBalanceThreshold": 100.00,
"updatedAt": "2026-05-24T10:00:00Z",
"totalCardBalance": 3250.00
},
"meta": {
"requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
"platform": "Fyatu CaaS",
"timestamp": "2026-05-24T10:00:00Z"
}
}
Field Reference
| Field | Type | Description |
|---|---|---|
balance | number | Operational (program ledger) balance in USD — available for card issuance, JIT funding, and invoice payments |
currency | string | Always USD |
isLow | boolean | true when balance is at or below lowBalanceThreshold. Always false when no threshold is configured (lowBalanceThreshold is null) |
lowBalanceThreshold | number | null | Alert threshold in USD, or null when no threshold is configured. Configure via the portal Settings page |
updatedAt | string | ISO 8601 timestamp of the last balance change. Returns the current time when no balance record exists yet |
totalCardBalance | number | Summed available balance held across the business’s spendable cards, in USD (distinct from balance, which is the unloaded program balance) |
Subscribe to the
ACCOUNT_LOW_BALANCE webhook event to receive real-time alerts when your balance falls below the configured threshold.Error Codes
| Code | HTTP | Cause |
|---|---|---|
AUTH_TOKEN_MISSING | 401 | No API key provided |
AUTH_TOKEN_INVALID | 401 | API key not recognised or revoked |
INSUFFICIENT_SCOPE | 403 | Key lacks accounts:read scope |
Authorizations
API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

