🔒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}

Authorizations

Path parameters

businessIdstring · uuidrequired

The business ID to search by.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/businesses/{businessId}' \
  --header 'Authorization: YOUR_API_KEY'

200

404

200

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

Returns the business with the specified ID.