Sandbox Environment: All examples in this guide use the sandbox
environment (
https://sandbox.hifibridge.com). Transactions are simulated -
no real money moves. When you’re ready for production, replace the sandbox URL
with the production endpoint.Prerequisites
Before receiving money, ensure you have:- ✅ User created with Terms of Service accepted
- ✅ KYC completed and approved for the target rail
- ✅ Virtual Account set up for receiving deposits
- ✅ API keys from the Dashboard
If you haven’t set up users, KYC, or accounts yet, see the Quickstart
Guide for step-by-step instructions.
How Receiving Money Works
- User deposits fiat to their virtual account (via bank transfer)
- HIFI detects the deposit
- HIFI converts fiat to stablecoins at the current exchange rate
- Stablecoins are sent to the user’s wallet on the specified blockchain
Production Flow
In production, receiving money happens automatically when your user sends money from their bank to the virtual account. HIFI detects the deposit and creates an onramp transaction. User sends money to:- Bank account details from the virtual account’s
depositInstructions - Routing number and account number for ACH, Wire, or RTP
Sandbox: Simulate Deposit
In sandbox, use the simulate endpoint to create a test deposit: Request:How the money is being sent:
wire, ach, or rtpSimulates the sender’s bank information. This represents the bank account
sending money TO the virtual account.
Amount of fiat being deposited (will convert to equivalent stablecoins).
Unique identifier for this deposit simulation (UUID).
Monitor Status
HIFI creates an onramp transaction when a deposit is detected. You’ll receive aONRAMP.CREATE webhook event with transaction details.
Status Progression:
FIAT_PENDING- Waiting for fiat to settleCRYPTO_PENDING- Converting and sending cryptoCOMPLETE- Stablecoins delivered to wallet
- Webhooks: Subscribe to
ONRAMP.UPDATEevents for real-time notifications - Polling: Call Retrieve an onramp with the transaction ID
Related Resources
- Quickstart Guide - Set up users, KYC, and accounts
- Send Money - Convert stablecoins back to fiat
- Onramps - Detailed onramp documentation
- Webhooks - Real-time transaction monitoring
- API Reference - Complete endpoint documentation