WalletGet Wallet Balance

Get Wallet Balance

The Wallet Balance API allows users to retrieve the financial status of their wallet in a specified currency.

Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/wallet_balance/{currency}

Replace {currency} with the desired currency code, such as NGN or USD.

Example cURL Request

curl -X GET https://backendapi.sayswitchgroup.com/api/v1/wallet_balance/NGN \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

Successful Response (Naira Wallet)

{
  "success": true,
  "message": "Wallet Balance Fetched Successfully",
  "data": {
    "currency": "NGN",
    "balance": "1154.2",
    "pending": "-10.12"
  }
}

Successful Response (Dollar Wallet)

{
  "success": true,
  "message": "Wallet Balance Fetched Successfully",
  "data": {
    "currency": "USD",
    "balance": "0.00",
    "pending": "100.00",
    "pending_available": "39.00",
    "refund_pending": "101.00",
    "refund_pending_unsettled": "61.00"
  }
}
FieldTypeDescription
successbooleanIndicates whether the request was successful.
messagestringA human-readable message describing the result of the request.
dataobjectContains wallet information.
data.currencystringThe currency code of the wallet (e.g., ‘NGN’ for Naira, ‘USD’ for Dollar).
data.balancestringThe current available balance in the wallet.
data.pendingstringGross pending settlement balance.
data.pending_availablestringPending balance not already reserved for refunds.
data.refund_pendingstringTotal money reserved for active refunds, including the refund amount and fee.
data.refund_pending_unsettledstringRefund reservation still waiting to be funded by settlement.

Use pending_available, not gross pending, when showing spendable pending funds. Existing refund holds are excluded from pending_available and cannot be reused by another refund.