This represents one possible implementation approach. Other valid implementations may vary based on your specific requirements.

​
Integration Flow

Step #0 -> Contact us

To begin integration, it is highly recommended and even required to contact the Breeze Team to discuss the details of Your Specific Product Integration. We will provide You with all necessary data, API keys, accounts, and any custom settings related to fees and risk. Also we will assign to Your Product your personal fund.
1

Deposit Funds

Process User Deposits

When a user wants to deposit:
  • Use POST /deposit/tx to generate a complete transaction, or
  • Use POST /deposit/ix for more control over transaction construction
  • User signs the transaction with their wallet
  • Submit to Solana network to complete the deposit
2

Monitor Portfolio

Track Performance & Analytics

Regularly update user portfolio data:
  • GET /user-balances/{user_id} for real-time portfolio values
  • GET /user-yield/{user_id} for earned yield values
  • Display yield earned, current risk exposure, and portfolio growth
3

Withdraw Funds

Process User Withdrawals

When a user wants to withdraw:
  • Use POST /withdraw/tx to generate a complete withdrawal transaction, or
  • Use POST /withdraw/ix for custom transaction handling
  • Specify amount of assets to withdraw or use "all": true for full withdrawal
  • User signs the transaction to complete the withdrawal process