Integration Guides

Set-and-forget widget or finely tuned API integration? Whatever your needs, our flexible infrastructure's got you covered.

Contents

ImplementationUI
Core widget integrationSolflare
Quick API IntegrationWallet in Telegram
API integration with Onramper as a single onrampCake Wallet
Core API integrationPhantom/Coinbase Wallet

Core widget integration

🎨 UI: Solflare

πŸ‘

Ideal for

Platforms that want the quintessential Onramper experience with minimal setup.

How to integrate

  • Pass thewalletsor networkWalletsURL parameters
  • Pass theonlyCryptosoronlyCryptoNetworksparameters

πŸ’‘

Best practice

Mobile wallet platform? Use webview for a more streamlined user experience.

Pros

  • Integrates within hours
  • The Onramper widget achieves higher success rates than in-house solutions
  • Auto-selects the correct fiat currency (based on user IP)
  • Auto-selects the best payment method and onramp
  • Visually distinguishes low-KYC, OTC and DCA methods
  • Can be easily tailored to your needs with URL parameters

Cons

Quick API Integration

🎨 UI: Wallet in Telegram


πŸ‘

Ideal for

Players seeking a simple API integration with little dev overhead.

How to integrate

  • Pass thewalletsor networkWalletsURL parameters
  • Pass the onlyCryptos (or onlyCryptoNetworks) URL parameters
  • Use the skipTxScreen parameters to skip Onramper's widget and go directly to onramp checkout
  • [OPTIONAL] Add a payment method selection screen. If no payment method is selected, Onramper will automatically default to the best payment method available for the user's country.
  • [OPTIONAL] Use the txnOnramp parameter to select the onramp the user is redirected to. If no onramp is specified, Onramper will automatically default to the best onramp available for the user's payment method and country. The recommendation-engine takes into account many variables including price, success rate, KYC friction and more.

πŸ’‘

Best practice

Enable auto-selection of the best fiat currency (based on the user’s IP address), add a payment method selection screen with the payment method recommended by Onramper pre-selected, and do not specify txnOnramp to make the most of Onramper's routing.

Pros

  • Automatically recommends the best payment method, as well as the best onramp for that payment method, making full user of Onramper's intelligent routing algorithms
  • Minimal Onramper screens
  • Minimal effort with full customization (build or bring your own UI)

Cons

  • A change of payment method is only possible after being redirected to the onramp, unless best practices are followed.
  • No support for alternative routes: if the recommended onramp doesn’t work for the user, there's no fallback-onramp unless you add an onramp selection screen (see integration below).
  • No low-KYC/DCA/OTC labeling

API integration with Onramper as a single onramp

🎨 UI: Cake Wallet



πŸ‘

Ideal for

Platforms that want to add or maintain other onramp integrations in their own UI, but haven't built a payments method selector.

How to integrate

  • Passwalletsor networkWalletsURL parameters
  • Pas the onlyCryptos or onlyCryptoNetworks parameters
  • Pass defaultCrypto , and defaultAmount
  • [ADDITIONAL] If building your own selection screen, use supported APIs to determine when to display Onrampe

πŸ’‘

Best practice

Leverage Onramper’s quotes API to provide your users with real-time information on their purchase. Consider localizing the fiat currency (based on user IP or app store location).

Pros

  • Flows within the Onramper widget include success rate recommendations, price-based comparisons, and labeling DCA/OTC options
  • Recommends the best onramp per payment method within Onramper
  • Integrates easily with existing onramp stacks or previously built UIs
  • Theme customization is easy

Cons

  • Introduces duplication in input screens
  • Quotes are based on assumed payment method. If a user switches payment method later in the flow, the supplied quote may no longer be valid.
  • Leverages additional endpoints (which may require extra dev work)

Core API integration

🎨 UI: Coinbase Wallet


πŸ‘

Ideal for

Those that need a powerful, flexible solution that provides a fully customized look and feel.

How to integrate

  • Pass the same parameters as the previous section, plus:
    • use the quotes API to get quotes, limits, available providers and information on low-KYC and onramp ranking
    • The txnOnramp parameter to the checkout API
    • The skipTransactionScreen parameter

πŸ’‘

Best practice

Consider displaying quotes and rankings based on quotes by using the quotes API. Payment method will be automatically assumed based on location. You may also want to show labels returned (low-KYC, highest success rate) and highlight the most recently used onramp.

Always localise the fiat currency based on the user's IP or app store location.

We also recommend adding a payment method selector, and adjusting the list of available onramps depending on the selection.

Consider displaying quotes and rankings based on the data provided by the quotes API β€” payment method will be automatically inferred based on the user's location. For the best UX, display the labels returned (low-KYC, highest success rate) and highlight the most recently used

Pros

  • Great control over UI customization
  • Can be easily integrated into existing non-Onramper infrastructure
  • No duplication of input screens
  • Chooses the best onramp per payment method (when following best practices)
  • Onramper's smart onramp ranking boosts conversions by 30-80% (when following best practices)

Cons

  • Certain widget features are unavailable or require additional work (e.g. in-built localization, DC)
  • Best practice results in the best user experience, at the cost of additional work