Balance

Fetch wallet balance

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.

get/api/v1/org/balance

Request

Base URL
https://sandbox.api.afriex.com
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.

Query parameters

currenciesstring

Comma-separated list of currencies to fetch balances for. If omitted, balances for all supported currencies are returned.

walletType'DEPOSIT' | 'WITHDRAW' | 'FEE'

The wallet to read. Defaults to WITHDRAW, the Payout wallet. FEE reads the wallet that settles transaction fees, which is zero for a business that does not use one. DEPOSIT reads the Collection wallet, and returns an empty data object while the Collection wallet is not enabled.

Response

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

dataobject

Example response

{
  "data": {
    "USD": 100.5,
    "EUR": 250.75,
    "GBP": 300
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.