🔒Get business balances

Fetch business balance

get

Allows you to fetch the current business balance.

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

^FRX-API api-key=[^,]+,signature=[^,]+,timestamp=[\d]+$

Path parameters

businessIdstring · uuidRequired

The business ID to search by.

Responses

200

Returns the specified business's balance.

application/json

businessIdstring · uuidRequired

businessNamestringRequired

fiatAllocationstringRequiredDeprecated

Deprecated. Ratio of fiat to all settlements allocation for crypto deposits.

settlementFiatCurrencystring · enumRequiredDeprecated

Deprecated.

Possible values:

settlementFiatAmountstringRequiredDeprecated

Deprecated. Use balances. settlementFiatCurrency balance.

displayFiatAmountstringRequiredDeprecated

Deprecated. Use balances. settlementFiatCurrency balance converted to EUR.

cryptoAllocationstringRequiredDeprecated

Deprecated. Ratio of crypto to all settlements allocation for crypto deposits.

settlementCryptoCurrencystring · enumRequiredDeprecated

Deprecated.

Possible values:

settlementCryptoAmountstringRequiredDeprecated

Deprecated. Use balances. settlementCryptoCurrency balance.

displayCryptoAmountstringRequiredDeprecated

Deprecated. Use balances. settlementCryptoCurrency balance converted to EUR.

get

/v1/balances/{businessId}

HTTPcURLJavaScriptPython

GET /v1/balances/{businessId} HTTP/1.1
Host: api.finrax.com
Authorization: YOUR_API_KEY
Accept: */*

200

Returns the specified business's balance.

{
  "businessId": "231cd908-65de-4f88-983e-83ba17102a6c",
  "businessName": "businessName",
  "fiatAllocation": "1",
  "settlementFiatCurrency": "EUR",
  "settlementFiatAmount": "10000.55",
  "displayFiatAmount": "12000",
  "cryptoAllocation": "0",
  "settlementCryptoCurrency": "USDC",
  "settlementCryptoAmount": "50000.123456",
  "displayCryptoAmount": "55000",
  "balances": {
    "EUR": {
      "amount": "10000.55",
      "uniformAmount": "12000"
    },
    "USDC": {
      "amount": "50000.123456",
      "uniformAmount": "55000"
    }
  }
}