🔒Get business balance

Fetch business balance

Allows you to fetch the current business balance and allocation ratio of a given business.

GET/api/v1/balances/{businessId}

Authorization

ApiKeyAuth

Path parameters

businessId*string (uuid)

The business ID to search by.

Response

200

Returns the specified business's balance.

Body

application/json

businessId*string (uuid)

businessName*string

fiatAllocation*string

Ratio of fiat to all settlements allocation for crypto deposits.

settlementFiatCurrency*enum

EURGBPUSD

settlementFiatAmount*string

settlementFiatCurrency balance.

displayFiatAmount*string

settlementFiatCurrency balance converted to EUR.

cryptoAllocation*string

Ratio of crypto to all settlements allocation for crypto deposits.

settlementCryptoCurrency*enum

BTCUSDC

settlementCryptoAmount*string

settlementCryptoCurrency balance.

displayCryptoAmount*string

settlementCryptoCurrency balance converted to EUR.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/balances/{businessId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "businessId": "123e4567-e89b-12d3-a456-426614174000",
  "businessName": "text",
  "fiatAllocation": "text",
  "settlementFiatCurrency": "EUR",
  "settlementFiatAmount": "text",
  "displayFiatAmount": "text",
  "cryptoAllocation": "text",
  "settlementCryptoCurrency": "BTC",
  "settlementCryptoAmount": "text",
  "displayCryptoAmount": "text"
}