---
title: "Fetch wallet balance"
method: GET
path: "/api/v1/org/balance"
tags: ["Balance"]
---

# Fetch wallet balance

`GET /api/v1/org/balance`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/org/balance`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/org/balance/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns one wallet's balances in the provided currencies, as a flat currency-to-amount map: the **Payout (Withdraw) wallet** by default, the **Fee wallet** with `walletType=FEE`, or the **Collection (Deposit) wallet** with `walletType=DEPOSIT`. The Collection wallet is the one that `settlement: "request"` withdrawals debit and that pool-account deposits credit.

## Query parameters

- `currencies` string
- `walletType` 'DEPOSIT' | 'WITHDRAW' | 'FEE'

## Response `200`

Returns a map with currencies as keys and balances as values.

- object
  - `data` object

## Other responses

- `400`: Invalid request parameters.
- `401`: Unauthorized - Invalid business API key.
- `404`: Business not found.
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)