🔒Get business by ID

Get Business by ID

GET https://payments.finrax.com/api/v1/businesses/:id

This endpoint allows you to get the business information

Path Parameters

Name	Type	Description
id*	string	ID of the business UUID

200 Cake successfully retrieved.

{
    "createdAt": 1632734682,
    "depositReceivedCallbackUrl": "https://example.com/deposits",
    "id": "dab81a7a-2502-4784-ad34-87e04e5129f0",
    "name": "My Business",
    "overpaymentPolicy": "EXCESS_REFUND",
    "refundFollowUpDepositsForOneTimePayments": true,
    "settlementCryptoCurrency": "USDT",
    "settlementCryptoRatio": "1.00",
    "settlementFiatCurrency": "EUR",
    "supportedDepositCurrencies": [
        "XRP",
        "ETH",
        "LTC",
        "BTC",
        "XLM"
    ],
    "supportedDisplayCurrencies": [
        "USD",
        "EUR"
    ],
    "theme": "LIGHT",
    "withdrawalCallbackUrl": "https://example.com/withdrawals"
}

Due to security reasons, we don't return BusinessID as a response field to any API calls. You can locate the BusinessID in your Finrax organisation account. Click on Businesses > Expand Business > Top left corner.

Response schema

Parameter	Type	Description
createdAt	number [required]	UNIX timestamp when the business got created
depositReceivedCallbackUrl	string [optional]	URL endpoint to receive callback notifications at broadcast/receive time
id	string [required]	Unique business identifier UUID
name	string [required]	Name of your business
settlementCryptoCurrency	string [required]	Cryptocurrency for settlements
settlementCryptoRatio	string [required]	Fiat/Crypto ratio for deposit allocation
settlementFiatCurrency	string [required]	Fiat currency for settlements. Currently only EUR is supported
supportedDepositCurrencies	array [required]	Array with all supported cryptocurrencies of this business
supportedDisplayCurrencies	array [required]	Array with all supported fiat currencies for pairing
overpaymentPolicy	string [required]	Payment configuration for overpayments. Can be one of: EXCESS_REFUND or PROCESS
refundFollowUpDepositsForOneTimePayments	boolean [required]	Payment configuration if follow-up deposits should be refunded.
theme	string [required]	Theme of the checkout page
withdrawalCallbackUrl	string [optional]	URL endpoint to receive callbacks at withdrawal completion time