Skip to main content
GET
/
api
/
v1
/
wallets
/
{wallet_id}
/
balance
Get Wallet Balance
curl --request GET \
  --url https://api-production.fossapay.com/api/v1/wallets/{wallet_id}/balance
{
  "status": "success",
  "data": {
    "wallet_id": "wal_abc123",
    "balances": [
      {
        "currency": "NGN",
        "available_balance": 150000,
        "ledger_balance": 150000,
        "pending_balance": 0
      },
      {
        "currency": "USDT",
        "available_balance": 100.50,
        "ledger_balance": 100.50,
        "pending_balance": 0
      }
    ]
  }
}

Documentation Index

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

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

​
Path Parameters

​
wallet_id
string
required
The unique identifier of the wallet

​
Query Parameters

​
currency
string
Filter by specific currency (optional)

​
Request Example

curl "https://api-production.fossapay.com/api/v1/wallets/wal_abc123/balance?currency=NGN" \
  -H "Authorization: Bearer fp_live_sk_xxxxxxxx"

const response = await fetch(
  'https://api-production.fossapay.com/api/v1/wallets/wal_abc123/balance?currency=NGN',
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer fp_live_sk_xxxxxxxx',
      'Content-Type': 'application/json'
    }
  }
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const balance = await response.json();

​
Response

{
  "status": "success",
  "data": {
    "wallet_id": "wal_abc123",
    "balances": [
      {
        "currency": "NGN",
        "available_balance": 150000,
        "ledger_balance": 150000,
        "pending_balance": 0
      },
      {
        "currency": "USDT",
        "available_balance": 100.50,
        "ledger_balance": 100.50,
        "pending_balance": 0
      }
    ]
  }
}