🔒Get business by ID

Fetch business by ID

Fetch business by ID. You can locate the BusinessID in your organisation account. Click on Businesses > Expand Business > Top left corner.

GET/api/v1/businesses/{businessId}

Authorization

ApiKeyAuth

Path parameters

businessId*string (uuid)

The business ID to search by.

Response

200404

Returns the business with the specified ID.

Body

application/json

id*string (uuid)

Business ID.

name*string

Business name.

depositReceivedCallbackUrlstring

URL endpoint to receive callback notifications at broadcast/receive time.

withdrawalCallbackUrlstring

URL endpoint to receive callbacks at withdrawal completion time.

withdrawalApprovalCallbackUrlstring

URL endpoint to receive callbacks at withdrawal approval/rejection time.

supportedDisplayCurrencies*array of enum

All supported fiat currencies.

supportedDepositCurrencies*array of enum

All supported cryptocurrencies.

supportedDepositCurrenciesWithNetworks*object

All supported cryptocurrencies with networks.

settlementCryptoRatio*string

Crypto settlement balance to whole balance ratio used for deposit allocation.

settlementCryptoCurrency*enum

Cryptocurrency for settlements.

BTCUSDC

settlementFiatCurrency*enum

Fiat currency for settlements.

EURGBPUSD

overpaymentPolicy*enum

The policy to be applied in case of overpayment.

PROCESSEXCESS_REFUND

refundFollowUpDepositsForOneTimePayments*boolean

Payment configuration if follow-up deposits should be refunded.

userServiceFeeDistributionPercentage*string

The service fee percentage that is taken from the user.

createdAt*integer (int64)

UNIX seconds at which the business got created.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "depositReceivedCallbackUrl": "text",
  "withdrawalCallbackUrl": "text",
  "withdrawalApprovalCallbackUrl": "text",
  "supportedDisplayCurrencies": [
    "AED"
  ],
  "supportedDepositCurrencies": [
    "BCH"
  ],
  "settlementCryptoRatio": "text",
  "settlementCryptoCurrency": "BTC",
  "settlementFiatCurrency": "EUR",
  "overpaymentPolicy": "PROCESS",
  "refundFollowUpDepositsForOneTimePayments": false,
  "userServiceFeeDistributionPercentage": "text"
}