Get Balances

Get All Balances

Retrieve balances for all supported currencies.

GET /v1/wallet/balances

Headers

Header	Required	Description
`X-Api-Key`	Yes	Your API key

Example Request

curl -X GET "https://api.esca.finance/v1/wallet/balances" \
  -H "X-Api-Key: your_api_key_here"

Example Response

{
  "status": true,
  "message": "Balances retrieved successfully",
  "data": [
    {
      "currency": "USD",
      "ledgerBalance": 10500.50,
      "availableBalance": 9800.25
    },
    {
      "currency": "EUR",
      "ledgerBalance": 5000.00,
      "availableBalance": 5000.00
    },
    {
      "currency": "GBP",
      "ledgerBalance": 3200.75,
      "availableBalance": 3200.75
    },
    {
      "currency": "NGN",
      "ledgerBalance": 0,
      "availableBalance": 0
    },
    {
      "currency": "BTC",
      "ledgerBalance": 0.5432,
      "availableBalance": 0.5432
    },
    {
      "currency": "USDT",
      "ledgerBalance": 25000.00,
      "availableBalance": 24500.00
    },
    {
      "currency": "USDC",
      "ledgerBalance": 15000.00,
      "availableBalance": 15000.00
    }
  ]
}

Get Balance by Currency

Retrieve the balance for a specific currency.

GET /v1/wallet/balances/:currency

Path Parameters

Parameter	Type	Required	Description
`currency`	string	Yes	Currency code: `USD`, `EUR`, `GBP`, `NGN`, `BTC`, `USDT`, or `USDC`

Example Request

curl -X GET "https://api.esca.finance/v1/wallet/balances/USD" \
  -H "X-Api-Key: your_api_key_here"

Example Response

{
  "status": true,
  "message": "Balance retrieved successfully",
  "data": {
    "currency": "USD",
    "ledgerBalance": 10500.50,
    "availableBalance": 9800.25
  }
}

Response Fields

Field	Type	Description
`currency`	string	Currency code
`ledgerBalance`	number	Total balance including pending/unsettled transactions
`availableBalance`	number	Settled funds available to spend

Ledger Balance vs Available Balance

Ledger balance includes all credited funds, whether settled or still processing.
Available balance only includes settled funds that can be used for payouts or transfers immediately.

The difference between the two represents funds that are still being processed (e.g., pending deposits).

Error Responses

Unsupported Currency

{
  "status": false,
  "message": "Unsupported currency: XYZ"
}

Overview