Finrax API

Fetch business balance

GET

/api/v1/balances/{businessId}

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

Request

Authorization

Add parameter in header

FRX-API

Example:

FRX-API: ********************

Path Params

businessId

string <uuid>

required

The business ID to search by.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Returns the specified business's balance.

application/json

Body

businessId

string <uuid>

required

businessName

string

required

fiatAllocation

string

required

Ratio of fiat to all settlements allocation for crypto deposits.

settlementFiatCurrency

enum<string>

required

Allowed values:

EURGBPUSD

settlementFiatAmount

string

required

settlementFiatCurrency balance.

displayFiatAmount

string

required

settlementFiatCurrency balance converted to EUR.

cryptoAllocation

string

required

Ratio of crypto to all settlements allocation for crypto deposits.

settlementCryptoCurrency

enum<string>

required

Allowed values:

BTCUSDCUSDT

settlementCryptoAmount

string

required

settlementCryptoCurrency balance.

displayCryptoAmount

string

required

settlementCryptoCurrency balance converted to EUR.

Example

{
    "businessId": "231cd908-65de-4f88-983e-83ba17102a6c",
    "businessName": "businessName",
    "fiatAllocation": "0.7",
    "settlementFiatCurrency": "EUR",
    "settlementFiatAmount": "10000.55",
    "displayFiatAmount": "12000",
    "cryptoAllocation": "0.3",
    "settlementCryptoCurrency": "USDT",
    "settlementCryptoAmount": "50000.123456",
    "displayCryptoAmount": "55000"
}

Modified at 2024-07-24 14:04:47

Fetch business by ID

Unwhitelist an address