coin, token, chain, and market should come from Rivo-supported values. Do not hard-code values unless Rivo has confirmed them for your environment.
Common examples
| Field | Where to get it | Used for |
|---|---|---|
coin or token | Rivo-supported asset list or GET /api/v1/utils/rates | Wallet creation, swaps, and deposits |
chain | GET /api/v1/utils/{coin}/networks | Crypto deposit addresses |
market | GET /api/v1/wallets/markets | Market display and rate checks |
bankCode | Your approved payout bank-code source | NGN payout preview |
Fixed values
These values are fixed by the current API contract.| Field | Allowed values | Used for |
|---|---|---|
withdrawalFee.type | crypto, local | GET /api/v1/wallets/withdrawal-fee |
market.base | ngn, usdt | GET /api/v1/wallets/markets/{market} |
paymentLink.type | crypto, fiat | POST /api/v1/payment-links |
paymentLink.status | pending, completed, expired, failed, cancelled | Payment-link reads and webhooks |
transaction.status | initiated, pending, processing, completed, failed, partially_completed | Transaction reads |
transaction.payoutStatus | payout_pending, pending, completed, failed | Payout and withdrawal transaction reads |
Dynamic values
These values can differ by environment and should be fetched instead of guessed.| Field | How to choose it | Notes |
|---|---|---|
token | Use the asset reference returned by supported asset/rate discovery. | Used when creating a wallet. Example: usdt, bitcoin, naira. |
coin | Use the asset reference returned by supported asset/rate discovery. | Used for deposit addresses, withdrawals, fees, and minimums. |
chain | Use the network reference returned by GET /api/v1/utils/{coin}/networks. | Used for crypto deposit addresses and withdrawals. Example: tron, binance, ethereum. |
from / to | Use supported asset references. | Used for swap quote and swap creation. |
currency | Use a supported fiat or crypto asset reference. | Used for payment links. |
network | Use a supported chain reference for the selected crypto currency. | Required for crypto payment links. |
bankCode | Use the bank-code source approved for your integration. | Used for local NGN payout preview. |
Flow mapping
| Step | Call | Take from response | Use it in |
|---|---|---|---|
| Discover assets | GET /api/v1/utils/rates | asset reference | token, coin, swap from, swap to, payment-link currency |
| Discover networks | GET /api/v1/utils/{coin}/networks | network reference | chain, payment-link network |
| Create wallet | POST /api/v1/wallets/generate-wallet | wallet data and asset context | wallet list, balance display, deposit address |
| Get deposit address | GET /api/v1/wallets/deposit-address | deposit address | Show to customer for crypto funding |
| Preview payout | POST /api/v1/wallets/preview-withdraw-local-transfer | transactionId | POST /api/v1/wallets/verify-withdrawal |
| Preview withdrawal | POST /api/v1/wallets/preview-withdraw | transactionId | POST /api/v1/wallets/verify-withdrawal |
| Quote swap | GET /api/v1/swaps/quotes | quote details | Show customer before creating swap |
| Create swap | POST /api/v1/swaps | swap transaction ID | confirm or cancel swap |
| Create payment link | POST /api/v1/payment-links | payment link id, code, payment URL/details | Share link, fetch public link, expire link |
Why this matters
These values can change when assets, networks, markets, or payout routes are added, renamed, or disabled. Discovery endpoints keep your integration in sync.Recommended pattern
- Fetch the available options.
- Store the selected ID only for the current flow.
- Preview the payout before confirmation.
- Submit the confirmation only after the user confirms the preview.