Key concepts
- Deposits are detected automatically when incoming funds arrive at the generated deposit address. No quote is required.
- Withdrawals are quote-based — the user must confirm a quote before the transaction is created and broadcast.
- Execution modes — transactions can be processed on-chain, off-chain (between Uphold users), or in simulated mode (sandbox only).
- Transaction rules — some quotes may include requirements (e.g., Travel Rule) that must be resolved before creating the transaction. On-hold transactions may require pending RFIs to be resolved.
Start building
Deposit via API
Generate a deposit address and monitor for incoming on-chain transfers.
Withdrawal via API
Create and broadcast a crypto withdrawal to an external address.
Deposit via Widget (End-to-end)
Recommended. Support crypto deposits in a single widget session — account selection through the deposit address.
Withdrawal via Widget (End-to-end)
Recommended. Send crypto withdrawals in a single widget session — account selection through the Travel Rule and transaction confirmation status.
Deposit via Widget (Transaction - Select Deposit Origin)
Let users select a crypto network and receive deposit instructions with a low-code, embeddable widget.
Withdrawal via Widget (Transaction - Select Withdrawal Destination)
Let users select a network and enter their address; you build the amount and review screens and create the quote and transaction via the REST API.