> ## Documentation Index > Fetch the complete documentation index at: https://docs.stabyl.com/llms.txt > Use this file to discover all available pages before exploring further. # Get wallet balance overview > Returns current NGN and USD balances, including available and locked amounts. Use available balance for spend checks and locked balance to explain funds committed to pending activity. ## OpenAPI ````yaml /openapi/openapi.json get /partner/wallets/balances/overview openapi: 3.1.0 info: title: Stabyl API description: >- REST API for approved Stabyl accounts to automate exchange, wallet, and non-production simulation workflows. contact: name: Stabyl Support email: support@stabyl.com license: name: Proprietary version: 1.0.0 servers: - url: https://api.stabyl.com/v1 description: Production - url: https://api-staging.stabyl.com/v1 description: Staging security: [] tags: - name: Exchange description: Trading market data and order management for account automation. - name: Wallets description: >- Supported routes, deposit destinations, balances, transactions, and saved recipients. - name: Webhooks description: >- Outbound event delivery configuration and eventually consistent delivery history. Verify Standard Webhooks webhook-id, webhook-timestamp, and webhook-signature headers against the unchanged raw request body before parsing JSON. - name: Simulation description: Non-production endpoints for testing integration behavior. paths: /partner/wallets/balances/overview: get: tags: - Wallets summary: Get wallet balance overview description: >- Returns current NGN and USD balances, including available and locked amounts. Use available balance for spend checks and locked balance to explain funds committed to pending activity. operationId: get_partner_wallets_balances_overview responses: '200': description: Wallet overview content: application/json: schema: type: object required: - status - data properties: data: $ref: '#/components/schemas/WalletOverviewResponse' status: type: string enum: - success example: data: balances: - available: '49000.00' currency: NGN locked: '1000.00' rail_equivalents: null total: '50000.00' - available: '1000.00' currency: USD locked: '0.00' rail_equivalents: [] total: '1000.00' credit: available_credit: '0.00' credit_limit: '0.00' credit_used: '0.00' currency: USD net_negative: '0.00' net_positive: '0.00' next_due_at: null outstanding: '0.00' overdue: false status: active withdrawal_blocked: false generated_at: '2026-05-24T12:00:00Z' status: success '401': description: Unauthorized content: application/json: schema: type: object required: - status - error properties: error: type: object required: - code - message properties: code: type: string example: UNAUTHORIZED message: type: string example: missing X-Api-Key header status: type: string enum: - error example: error: code: UNAUTHORIZED message: missing X-Api-Key header status: error security: - api_key: [] components: schemas: WalletOverviewResponse: type: object description: NGN and USD wallet balance overview with generation timestamp. required: - balances - credit - generated_at properties: balances: type: array items: $ref: '#/components/schemas/WalletOverviewBalance' credit: $ref: '#/components/schemas/CreditSnapshotResponse' description: Credit line metrics snapshot. generated_at: type: string description: RFC3339 timestamp at which the overview was generated. WalletOverviewBalance: type: object description: >- Balance summary for one wallet currency, including total, available, and locked amounts. required: - currency - total - available - locked properties: available: type: string example: '49000.00' currency: type: string example: NGN locked: type: string example: '1000.00' rail_equivalents: type: - array - 'null' items: $ref: '#/components/schemas/WalletRailEquivalentQuote' total: type: string example: '50000.00' CreditSnapshotResponse: type: object description: >- Credit information included in the wallet balance overview when applicable. required: - currency - available_credit - net_positive - net_negative - credit_limit - credit_used - outstanding - status - overdue - withdrawal_blocked properties: available_credit: type: string description: >- Additional credit currently available after both user and pool limits. example: '1000000.00' credit_limit: type: string description: Configured maximum credit exposure for this account. example: '1500000.00' credit_used: type: string description: >- Total credit in use, including open-order commitments and drawn debt. example: '500000.00' currency: type: string description: Credit line denomination. Credit exposure is normalized to USD. example: USD net_negative: type: string description: Drawn, unpaid credit exceeding the current USD wallet balance. example: '0.00' net_positive: type: string description: USD wallet balance remaining after subtracting drawn, unpaid credit. example: '250000.00' next_due_at: type: - string - 'null' description: Earliest due date among unpaid draw lots. outstanding: type: string description: Drawn credit that has not yet been repaid. example: '500000.00' overdue: type: boolean description: Whether any unpaid draw is overdue. example: false status: type: string description: Credit account status. example: active updated_at: type: - string - 'null' description: >- Projection timestamp used by streaming clients to reject older REST baselines. withdrawal_blocked: type: boolean description: >- Legacy debt indicator. This does not mean all withdrawals are blocked; withdrawal submission enforces an asset-specific protected floor. example: true WalletRailEquivalentQuote: type: object description: Indicative stablecoin rail equivalent for a USD wallet balance. required: - rail - status - estimated_receive - receive_currency - debit_amount - debit_currency - fee - expires_at - settlement_estimate properties: debit_amount: type: string example: '1000.00' debit_currency: type: string example: USD estimated_receive: type: string example: '999.350000' expires_at: type: string example: '2026-05-13T12:00:30Z' fee: type: string example: '0.65' rail: type: string example: USDT reason: type: - string - 'null' example: temporarily_unavailable receive_currency: type: string example: USDT settlement_estimate: type: string example: 10-30 minutes status: type: string example: available securitySchemes: api_key: type: apiKey in: header name: X-Api-Key description: >- API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers. x-default: sb_test_your_key ````