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"
}
}| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| message | string | A human-readable message describing the result of the request. |
| data | object | Contains wallet information. |
| data.currency | string | The currency code of the wallet (e.g., ‘NGN’ for Naira, ‘USD’ for Dollar). |
| data.balance | string | The current available balance in the wallet. |
| data.pending | string | Gross pending settlement balance. |
| data.pending_available | string | Pending balance not already reserved for refunds. |
| data.refund_pending | string | Total money reserved for active refunds, including the refund amount and fee. |
| data.refund_pending_unsettled | string | Refund 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.