Skip to main content
GET
/
balance
Get account balance
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/balance \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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
Deposit funds to this balance via your account’s crypto deposit address. The balance is always denominated in USD. Sandbox: The first call automatically seeds $10,000 in test funds. Subsequent calls return the live sandbox balance as it changes with card loads and transactions.

​
Example

curl https://api.fyatu.com/api/v3.20/balance \
  -H "Authorization: Bearer $FYATU_API_KEY"

​
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"
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-24T10:00:00Z"
  }
}

​
Field Reference

FieldTypeDescription
balancenumberOperational balance in USD — available for card issuance, JIT funding, and invoice payments
currencystringAlways USD
isLowbooleantrue when balance is at or below lowBalanceThreshold. Always false when the threshold is 0 (not configured)
lowBalanceThresholdnumberAlert threshold in USD. 0 means no threshold is configured. Configure via the portal Settings page
updatedAtstringISO 8601 timestamp of the last balance change. Returns the current time when no balance record exists yet
Subscribe to the program.balance.low webhook event to receive real-time alerts when your balance falls below the configured threshold.

​
Error Codes

CodeHTTPCause
AUTH_TOKEN_MISSING401No API key provided
AUTH_TOKEN_INVALID401API key not recognised or revoked
INSUFFICIENT_SCOPE403Key lacks accounts:read scope

Authorizations

​
Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Response

Balance retrieved

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Balance retrieved"

​
data
object
​
meta
object