Widget integration

With just a few lines of code, you can allow your users to purchase cryptocurrencies from your web or app.

You can integrate the widget in four different ways:

1. Redirect your users to the widget URL with a referral link. See more. 
2. Use an iframe or a webview to embed the widget in your application. See more.
3. Import a component in your React application. See more.
4. Add it to your static webpage using a CDN import. See more.

API Key

To allow users to buy crypto, you need an API key. To get an API key, fill in our onboarding form. Add your API key as a parameter in the URL of the code snippet as follows: https://widget.onramper.com?apiKey=theAPIkeyyoureceived.

Note: data retrieved with a test key can be not accurate, for real-time prices use a production key.

Partner Context & Webhooks

You can add your own transaction identifier/data field to your users' transactions by using a partnerContext. This allows you to (for example) track which user buys/deposits what currency & what amount. This partner context can be added using the parameter 'partnerContext' when integrating the widget. You can subsequently use the webhooks to listen to completed transactions. ⚠️ Please, note that not all our gateways support a partner context, for now, see the Available gateways section for more info. Soon all gateways will support this feature.

Referral link

You can simply add a link to your app or website to redirect users to a page (hosted by us) where the users can buy crypto. The widget URL is https://widget.onramper.com

If you want to receive a referral fee for every transaction done by users coming from your website, fill in our onboarding form to receive your API key and then add your API key to the link as follows: https://widget.onramper.com?apiKey=theAPIkeyyoureceived.

HTML code snippet

<a href="https://widget.onramper.com?color=1d2d50" target="_blank">
  Buy cryptocurrencies
</a>

Live example & customization

Easily customize the buy page by changing the URL with the available URL parameters.

Redirect customization examples: CodeSandbox

Iframe

Embed an iframe on your website. This is the easiest way to add the widget to your own page. Just copy-paste the code snippet below to your page. Customize your widget by adding URL parameters.

Note: To enable the widget for transactions, don't forget to add your API key. To enable some features in the widget, don't forget to add the allow attribute to the iframe element.

HTML code snippet

<iframe
  src="https://widget.onramper.com?color=266677&apiKey=pk_test_x5M_5fdXzn1fxK04seu0JgFjGsu7CH8lOvS9xZWzuSM0"
  height="660px"
  width="482px"
  title="Onramper widget"
  frameborder="0"
  allow="accelerometer;
  autoplay; camera; gyroscope; payment"
  style="box-shadow: 1px 1px 1px 1px
  rgba(0,0,0,0.2);"
>
  <a href="https://widget.onramper.com" target="_blank">Buy crypto</a>
</iframe>

Live example & customization

Iframe customization example

URL parameters

You can pass some arguments as query parameters to the URL to customize the widget For all parameters see CUSTOMIZE section

React component

You can also import the widget as a component in your React application.

Installation

# Using yarn
$ yarn add @onramper/widget

# Using npm
$ npm install @onramper/widget

Code snippet

import OnramperWidget from "@onramper/widget";

export default function WidgetContainer() {
  const wallets = {
    BTC: { address: "btcAddr" },
    BNB: { address: "bnbAddress", memo: "cryptoTag" },
  };

  return (
    <div
      style=
    >
      <OnramperWidget
        API_KEY={apiKey}
        color={defaultColor}
        fontFamily={fontFamily}
        defaultAddrs={wallets}
        defaultAmount={defaultAmount}
        defaultCrypto={defaultCrypto}
        defaultFiat={defaultFiat}
        defaultFiatSoft={defaultFiatSoft}
        defaultPaymentMethod={defaultPaymentMethod}
        filters=
        isAddressEditable={isAddressEditable}
        amountInCrypto={amountInCrypto}
        redirectURL={redirectURL}
        darkMode={darkMode}
      />
    </div>
  );
}

Live example & customization

While importing the widget as a React component, you can customize it using the component props below. CodeSandbox

Component props

For all props see CUSTOMIZE section

Javascript

Setup

Add an empty div tag to mark the spot where you want to display the widget and add a unique id to it.

<div id="onramper-widget"></div>

Then, add three script tags to load the necessary dependencies (React, ReactDOM) and the widget:

<!-- Load React. -->
<!-- Note: when deploying, replace "development.js" with "production.min.js". -->
<script
  src="https://unpkg.com/react@16/umd/react.development.js"
  crossorigin
></script>
<script
  src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"
  crossorigin
></script>

<!-- Load Onramper's widget. -->
<script
  src="https://unpkg.com/@onramper/widget/dist/index.js"
  crossorigin
></script>

After the three scripts load, add the widget to the DOM invoking the initialize function

Onramper.initialize("#onramper-widget");

Code snippet

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Static website</title>
    <script src="https://unpkg.com/react@16/umd/react.development.js" crossorigin></script>
    <script src="https://unpkg.com/react-dom@16/umd/react-dom.development.js" crossorigin></script>
    <script src="https://unpkg.com/@onramper/widget/index.js" crossorigin></script>
    <style>
      html,
      body {
        margin: 0;
        height: 100%;
      }
      #onramper-widget {
        width: 482px;
        height: 660px;
        box-shadow: 3px 3px 5px 0px rgba(0, 0, 0, 0.75);
        margin: 3rem auto;
      }
    </style>
  </head>
  <body>
    <div id="onramper-widget"></div>
    <script>
      Onramper.initialize("#onramper-widget");
    </script>
  </body>
</html>

Live example

CodeSandbox

Initialize parameters

For all parameters see CUSTOMIZE section

Native apps

You can also include Onramper's widget in any native application using a WebView or any component that is able to render a website, as if it was an iframe, for this, you should point the source URI to https://widget.onramper.com?apiKey=YOURAPIKEY. You can also customize it using the URL parameters.

Don't forget that iframes and webviews are isolated components so you should enable some features in order to allow the widget to work properly.

These features are:

• Camera and storage permission (in order to upload KYC documents)
• Features: accelerometer; autoplay; camera; gyroscope; payment (required by one or more gateways in order to work properly)
• Allow third-party cookies (used by one or more gateways)
• Allow the webview to open URLs automatically, without user interaction (payment redirects required by one or more gateways)
• Allow the webview to open URLs with the OS browser (payment redirects required by one or more gateways)

Customize

You can pass the following arguments to customize the widget. In React/JS integrations the attributes onlyCryptos, excludeCryptos, onlyPaymentMethods, excludePaymentMethods, excludeFiat, onlyGateways and onlyFiat should be contained in an object under the attribute filters.

Payment method IDs

IDs of all possible payment methods:

creditCard, bankTransfer, applePay, googlePay, paynow, fps, alipay-hk, prompt-pay, instapay, upi, gojek-id, viettel-pay, duit-now, ideal, bancontact, giropay, sofort, sepaBankTransfer