Partner Reference

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

Product	Description
crypto_buy_sell	The ability for your customers to buy and sell cryptocurrencies using your settlement for payments
crypto_swap	The ability for your customers to convert a cryptocurrency directly to other cryptocurrency
crypto_transfer	The ability to transfer cryptocurrencies between any of your customers. This is processed off-chain
crypto_send	The ability to send cryptocurrencies to a blockchain address
crypto_receive	The ability to receive cryptocurrencies from the blockchain
nft_receive	The ability to receive NFTs from the blockchain
investments	The 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

Field	Description	Type / Values	Example
id	Lirium's unique Identification for the cryptocurrency.	string	ETH
decimal_places	Indicates how many decimal places this asset supports	string_enum	18
allowed_operations	Indicates the operations allowed for this cryptocurrency	array_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

Field	Description	Type / Values	Notes	Example
id	Lirium's unique Identification for the investment asset token.	string		aEthUSDC
name	Name of the Investment Asset	string		Aave Ethereum USDC
quote_asset	Indicates which is the cryptocurrency asset that can be used to subscribe and redeem this investment	string		USDC
network	Indicates the blockchain where this asset exists	string		ethereum
provider_id	Id of the provider of this investment	string	see get investment providers	aave
enabled	Indicates whether this investment is enabled for operations	boolean		true
subscription	Dictionary containing limits for the subscribe investment operation
subscription.min_amount	Min amount of quote asset that can be subscribed	string_decimal		1
subscription.max_amount	Max amount of quote asset that can be subscribed	string_decimal		200000
redemption	Dictionary containing limits for the redeem investment operation
redemption.min_amount	Min amount of quote asset that can be redeemed	string_decimal		1
redemption.max_amount	Max amount of quote asset that can be redeemed	string_decimal		0
fee	Dictionary containing information of the fee charged by Lirium
fee.type	Fee type	string_enum		earnings_percentage
fee.value	Value corresponding to the type	string_decimal		5

📘

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.