Get started
Quickstart
From a test key to a deposit, a swap and a bank payout in five minutes. Nothing here moves real money.
1. Get a test key
Open Business → Infrastructure API and create a key with Test selected. It starts with rmo_test_, works at once and needs no verification. Add a webhook URL (a free one from webhook.site is fine) to watch events arrive.
2. Your sandbox is already funded
1,000 USDT, 1,000 USDC, 0.05 BTC and ₦1,000,000 of pretend money. Reset it any time from the same page.
3. Run the calls
On a wide screen they're on the right; below on a phone. Each step also arrives at your webhook, signed with the key's secret.
export RIMOSWAP_KEY=rmo_test_...
BASE=http://localhost:4188/api
# 1. Who am I?
curl $BASE/v1/account -H "X-Api-Key: $RIMOSWAP_KEY"
# 2. A USDT (Tron) address for your customer cus_1001
curl -X POST $BASE/v1/customers/addresses \
-H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \
-d '{ "customer_id": "cus_1001", "coin": "USDT", "network": "tron" }'
# 3. Pretend they sent 25 USDT (sandbox only)
curl -X POST $BASE/v1/sandbox/deposits \
-H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \
-d '{ "customer_id": "cus_1001", "coin": "USDT", "network": "tron", "amount": "25" }'
# 4. Sell 10 USDT for naira
curl -X POST $BASE/v1/swaps/quote \
-H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \
-d '{ "from": "USDT", "to": "NGN", "amount": "10" }'
curl -X POST $BASE/v1/swaps \
-H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \
-d '{ "quote_id": "sw_..." }'
# 5. Pay ₦10,000 to a bank account
curl -X POST $BASE/v1/bank-payouts \
-H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{ "bank_code": "058", "account_number": "0123456789", "amount": "10000" }'4. Go live
Swap the test key for a live one once your access is approved. Nothing else in your code changes. See Going live.
QuickstartcURL
export RIMOSWAP_KEY=rmo_test_... BASE=http://localhost:4188/api # 1. Who am I? curl $BASE/v1/account -H "X-Api-Key: $RIMOSWAP_KEY" # 2. A USDT (Tron) address for your customer cus_1001 curl -X POST $BASE/v1/customers/addresses \ -H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \ -d '{ "customer_id": "cus_1001", "coin": "USDT", "network": "tron" }' # 3. Pretend they sent 25 USDT (sandbox only) curl -X POST $BASE/v1/sandbox/deposits \ -H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \ -d '{ "customer_id": "cus_1001", "coin": "USDT", "network": "tron", "amount": "25" }' # 4. Sell 10 USDT for naira curl -X POST $BASE/v1/swaps/quote \ -H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \ -d '{ "from": "USDT", "to": "NGN", "amount": "10" }' curl -X POST $BASE/v1/swaps \ -H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \ -d '{ "quote_id": "sw_..." }' # 5. Pay ₦10,000 to a bank account curl -X POST $BASE/v1/bank-payouts \ -H "X-Api-Key: $RIMOSWAP_KEY" -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "bank_code": "058", "account_number": "0123456789", "amount": "10000" }'