Actions27
- Payment Actions
- Payout Actions
- Swap Actions
- Common Actions
Common → Get the Account Balances
AI-generatedSummary
Retrieve wallet balance details for a user optionally filtered by a specific currency.
Inputs
- General API Key (required) — Your OxaPay General API Key to authenticate the request, obtainable from your OxaPay Settings.
- Currency — Optional currency symbol to get the balance for that specific currency only.
Output shape
a single JSON object containing account wallet balances, optionally filtered by the specified currency.
If the currency parameter is omitted, the API returns balances for all currencies associated with the user's wallets. The operation requires a valid General API Key passed inline as a query parameter for authentication.
Examples
Example 1: Get overall account balances for all currencies
Set the General API Key and leave Currency empty to fetch all wallet balances.
Example 2: Get account balance for a specific currency
Set the General API Key and specify the Currency to retrieve the balance for that currency only.