The Partner resource represents the banking partner's account with Lirium.

The resource is used by Banking Partner to query useful information that helps monitoring the current status of the account in realtime, such as Settlement Account Balances, KPIs, etc

Products

As a partner, you can have some or all products offered by Lirium available to you, they are

ProductDescription
crypto_buy_sellThe ability for your customers to buy and sell cryptocurrencies using your settlement for payments
crypto_swapThe ability for your customers to convert a cryptocurrency directly to other cryptocurrency
crypto_transferThe ability to transfer cryptocurrencies between any of your customers. This is processed off-chain
crypto_sendThe ability to send cryptocurrencies to a blockchain address
crypto_receiveThe ability to receive cryptocurrencies from the blockchain
nft_receiveThe ability to receive NFTs from the blockchain
investmentsThe ability for your customers to invest their cryptocurrencies (Staking, Yield Farming)

📘

Off-chain transactions

If the destination of a send order is the address of another Lirium customer (it could be yours or from a different Partner) the transaction will be processed off-chain.

Off-chain transactions have no fees


Available Assets

All the cryptocurrencies available to operate are in the available_assets list of the Partner Details

These assets have the following fields

FieldDescriptionType / ValuesExample
idLirium's unique Identification for the cryptocurrency.stringETH
decimal_placesIndicates how many decimal places this asset supportsstring_enum18
allowed_operationsIndicates the operations allowed for this cryptocurrencyarray_of_strings["buy", "receive", "sell", "send", "transfer"]

Cryptocurrency Asset Operations

All the allowed operations on cryptocurrency assets are the following:

  • buy: Allows to buy this cryptocurrency. This can be done with a buy order or a swap order with this asset as the destination of the swap
    • Related products: crypto_buy_sell and crypto_swap
  • sell: Allows to sell this cryptocurrency. This can be done with a sell order or a swap order with this asset as the source of the swap
    • Related products: crypto_buy_sell and crypto_swap
  • transfer: Allows to sending and receive this cryptocurrency as a transfer off-chain.
    • Related product: crypto_transfer
  • send: Allows to send this cryptocurrency to the blockchain
    • Related product: crypto_send
  • receive: Allows to receive this cryptocurrency from the blockchain
    • Related product: crypto_receive

⚠️

Send and Receive operations vs products

There are some cryptocurrencies that do not allow the send and receive operations.

This means that regardless of having the products crypto_send and crypto_receive these cryptocurrencies blockchain operations are not supported


Available Investments

All the investments available to operate are in the available_investments list of the Partner Details

These assets have the following fields

FieldDescriptionType / ValuesNotesExample
idLirium's unique Identification for the investment asset token.stringaEthUSDC
nameName of the Investment AssetstringAave Ethereum USDC
quote_assetIndicates which is the cryptocurrency asset that can be used to subscribe and redeem this investmentstringUSDC
networkIndicates the blockchain where this asset existsstringethereum
provider_idId of the provider of this investmentstringsee get investment providersaave
enabledIndicates whether this investment is enabled for operationsbooleantrue
subscriptionDictionary containing limits for the subscribe investment operation
subscription.min_amountMin amount of quote asset that can be subscribedstring_decimal1
subscription.max_amountMax amount of quote asset that can be subscribedstring_decimal200000
redemptionDictionary containing limits for the redeem investment operation
redemption.min_amountMin amount of quote asset that can be redeemedstring_decimal1
redemption.max_amountMax amount of quote asset that can be redeemedstring_decimal0
feeDictionary containing information of the fee charged by Lirium
fee.typeFee typestring_enumearnings_percentage
fee.valueValue corresponding to the typestring_decimal5

📘

Fee Earnings Percentage

Lirium currently only charges the fee type earnings_percentage.

This means that when an Investment is redeemed, the earnings of that redemption is calculated based on the invested amount used to obtain the investment tokens vs the current value of those tokens. Then a percentage of those earnings are charged as fee.