Partner Details

GET https://api.lirium-sandbox.com/v1/partner

Retrieve partner account information

Retrieve details about your partner account, including supported currencies and their configurations.

📘

Recipe

The Buy Crypto, Send Crypto, and Subscribe to an Investment recipes all start here, checking products (and available_investments) before creating an order.

Request

GET /partner

Example Response

JSON

{
  "name": "Bank Name",
  "logo_url": "https://example.com/img/logo.png",
  "kyc_mode": "lirium_collect",
  "available_assets": [
    {
      "id": "BTC",
      "decimal_places": 8,
      "allowed_operations": ["buy", "receive", "sell", "send", "transfer"]
    },
    {
      "id": "ETH",
      "decimal_places": 18,
      "allowed_operations": ["buy", "receive", "sell", "send", "transfer"]
    },
    {
      "id": "USDC",
      "decimal_places": 6,
      "allowed_operations": ["buy", "receive", "sell", "send", "transfer"]
    }
  ],
  "available_investments": [
    {
      "id": "aEthUSDC",
      "quote_asset": "USDC",
      "network": "ethereum",
      "provider_id": "aave",
      "subscription": {"min_amount": "1", "max_amount": "200000"},
      "redemption": {"min_amount": "1", "max_amount": "0"},
      "fee": {"type": "earnings_percentage", "value": "5"},
      "name": "Aave Ethereum USDC",
      "enabled": true
    }
  ],
  "products": ["crypto_buy_sell", "crypto_receive", "crypto_send", "crypto_swap", "investments"],
  "available_incoming_fiat_instructions": [
    {
      "type": "ar_cvu",
      "creation_fees": [{"type": "fixed", "value": "1", "currency": "USD"}]
    }
  ],
  "available_outgoing_fiat_instructions": [
    {
      "type": "ar_cbu",
      "required_fields": [
        {"key": "cbu", "type": "string", "regex": "^[0-9]{22}$", "optional": false}
      ],
      "currencies": ["ARS"]
    }
  ],
  "delegation_enabled": true
}

Response Fields

Field	Type	Description
name	string	Partner account name
logo_url	string	URL of the partner logo
kyc_mode	string	KYC collection mode: no_kyc, partner_collect, or lirium_collect
available_assets	array	Assets enabled for the partner
available_assets[].id	string	Asset code (e.g., BTC, USDC)
available_assets[].decimal_places	integer	Number of decimal places for the asset
available_assets[].allowed_operations	array	Operations allowed for the asset (buy, receive, sell, send, transfer)
available_investments	array	Investment products enabled for the partner
available_investments[].id	string	Investment identifier (e.g., aEthUSDC)
available_investments[].quote_asset	string	Asset the investment is quoted/settled in
available_investments[].network	string	Network of the investment asset (lowercase)
available_investments[].provider_id	string	Investment provider
available_investments[].subscription	object	min_amount / max_amount for subscribing
available_investments[].redemption	object	min_amount / max_amount for redeeming (max_amount 0 means no cap)
available_investments[].fee	object	Fee type and value
available_investments[].name	string	Investment display name
available_investments[].enabled	boolean	Whether the investment is enabled
products	array	Enabled product codes for the partner (array of strings)
available_incoming_fiat_instructions	array	Incoming fiat instruction types the partner can offer (omitted/null when none)
available_incoming_fiat_instructions[].type	string	Instruction type (e.g., ar_cvu, mx_clabe)
available_incoming_fiat_instructions[].creation_fees	array	Creation fees, each {type, value, currency}
available_outgoing_fiat_instructions	array	Outgoing fiat instruction types the partner can offer (omitted/null when none)
available_outgoing_fiat_instructions[].type	string	Instruction type (e.g., ar_cbu, ar_alias, mx_clabe)
available_outgoing_fiat_instructions[].required_fields	array	Fields required to create the instruction, each {key, type, regex?, min_length?, max_length?, optional}
available_outgoing_fiat_instructions[].currencies	array	Currencies supported by the instruction type
delegation_enabled	boolean	Whether delegation is enabled for the partner

Notes

Use each available_assets[].decimal_places value to configure asset formatting and precision in your application.