🔒Get business by ID

Fetch business by ID

get

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

Authorizations
Path parameters
businessIdstring · uuidRequired

The business ID to search by.

Responses
200
Returns the business with the specified ID.
application/json
get
GET /api/v1/businesses/{businessId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "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"
  ],
  "supportedDepositCurrenciesWithNetworks": {
    "XRP": [
      "XRP"
    ],
    "BTC": [
      "BTC"
    ],
    "ETH": [
      "ETH",
      "BSC"
    ],
    "XLM": [
      "XLM"
    ],
    "LTC": [
      "LTC"
    ],
    "BCH": [
      "BCH"
    ]
  },
  "supportedDisplayCurrencies": [
    "EUR",
    "USD",
    "TRY"
  ],
  "settlementCryptoRatio": "0.25",
  "settlementCryptoCurrency": "USDC",
  "settlementFiatCurrency": "EUR",
  "overpaymentPolicy": "EXCESS_REFUND",
  "refundFollowUpDepositsForOneTimePayments": true,
  "userServiceFeeDistributionPercentage": "0.00",
  "createdAt": 1692879143
}

Last updated