How it works
Generate a deposit address
Call the deposit address endpoint with a unique identifier for your user. Obiex returns a wallet address tied to that user for a specific currency and network. If you call the endpoint again with the same identifier, the same address is returned.
Share the address with your user
Display the deposit address and network to your user so they can send funds from an external wallet or exchange.
Receive the deposit webhook
When the deposit is confirmed on-chain, Obiex sends a webhook to your webhook callback URL with the transaction details.
Deposit addresses are reusable. The same address will receive multiple deposits over time, so you do not need to generate a new address per transaction.
Key endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /addresses/broker | Generate a deposit address for a user |
| GET | /addresses/me/broker | List all deposit addresses you have generated |
| GET | /currencies/networks/active | List supported networks and deposit fee information |
| GET | /wallets/{currencyCode} | Check your master wallet balance |