Fetch business by ID

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Returns the business with the specified ID.

application/json

Body

id

string <uuid>

required

Business ID.

name

string

required

Business name.

depositReceivedCallbackUrl

string

optional

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

depositExchangedCallbackUrl

string

deprecated

URL endpoint to receive callback notifications at exchange time.

withdrawalCallbackUrl

string

optional

URL endpoint to receive callbacks at withdrawal completion time.

withdrawalApprovalCallbackUrl

string

optional

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

theme

string

deprecated

Theme of the checkout page.

supportedDisplayCurrencies

array[string]

required

All supported fiat currencies.

Allowed values:

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

supportedDepositCurrencies

array[string]

required

All supported cryptocurrencies.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

settlementCryptoRatio

string

required

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

settlementCryptoCurrency

enum<string>

required

Cryptocurrency for settlements.

Allowed values:

BTCUSDCUSDT

settlementFiatCurrency

enum<string>

required

Fiat currency for settlements.

Allowed values:

EURGBPUSD

overpaymentPolicy

enum<string>

required

The policy to be applied in case of overpayment.

Allowed values:

PROCESSEXCESS_REFUND

refundFollowUpDepositsForOneTimePayments

boolean

required

Payment configuration if follow-up deposits should be refunded.

userServiceFeeDistributionPercentage

string

required

The service fee percentage that is taken from the user.

createdAt

integer <int64>

required

UNIX seconds at which the business got created.

Example

{
    "id": "c95fc88b-5aba-4fec-a4df-c6834f304464",
    "name": "Test Business",
    "depositReceivedCallbackUrl": "https://example.com/test",
    "depositExchangedCallbackUrl": "https://example.com/test",
    "withdrawalCallbackUrl": "https://example.com/test",
    "theme": "LIGHT",
    "supportedDepositCurrencies": [
        "XRP",
        "BTC",
        "ETH",
        "XLM",
        "LTC",
        "BCH"
    ],
    "supportedDisplayCurrencies": [
        "EUR",
        "USD",
        "TRY"
    ],
    "settlementCryptoRatio": "0.25",
    "settlementCryptoCurrency": "USDT",
    "settlementFiatCurrency": "EUR",
    "overpaymentPolicy": "EXCESS_REFUND",
    "refundFollowUpDepositsForOneTimePayments": true,
    "userServiceFeeDistributionPercentage": "0.00",
    "createdAt": 1692879143
}

🟠404Business with the specified ID doesn't exist.