Example Deposit Flow
A reference UI flow for API-Managed Deposits, using the Oobit app as a visual guide
This page shows a reference example of the deposit flow you'll need to build when using API-Managed Deposits. The screenshots come from the Oobit app — your UI doesn't need to match exactly, but the steps below cover the minimum you'll want to implement.
Note: You're free to design this flow however you like. This is just a starting point that maps each screen to the Partner API calls backing it.
1. Select Token
Let the user pick which crypto they want to deposit. Fetch the available list from the List Crypto Currencies API so you always show the right set.
API used: List Crypto Currencies API — returns all supported crypto currencies with their networks, icons, and symbols.
2. Select Network
After a token is picked, let the user choose the network (e.g. USDT on Ethereum vs USDT on Solana). The network list comes from the same Currencies API — each currency exposes its supported networks.
API used: List Crypto Currencies API — each currency in the response includes its available networks.
3. Enter Amount (optional)
If your flow needs a declared amount, prompt the user for one. This step is optional — on-chain deposits are driven by whatever the user actually sends.
API used: none — handled entirely client-side.
4. Show Deposit Address
Fetch a deposit address for the selected token/network via the Get Deposit Address API, then show it to the user as a QR code plus copyable text. Include a warning about sending the correct asset on the correct network.
API used: Get Deposit Address API — identify the user by email or externalUserId. The user must be ACTIVE — see User Statuses.
See Also
- API-Managed Deposits — Full integration guide
- Get Deposit Address API — API reference
- List Crypto Currencies API — Token and network list
- Get User Status API — Check whether the user can receive deposits
Updated 3 days ago
