Here you will find instructions to add the Onramper widget in your website or application. 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: - Redirect your users to the widget URL with a referral link. See more. - Use an iframe or a webview to embed the widget in your application. See more. - Import a component in your React application. See more. - 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: Due to the nature of the data retrieved with a test key it has no guarantee of accuracy, for accurate real-time prices please 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 onramps support a partner context, for now, see Available onramps section for more info. Soon all onramps 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 in your website. This is the easiest way to add the widget on your own page. Just copy-paste the code snippet below in your page. Customize your widget by adding URL parameters.

Note: In order to enable the widget for transactions, don't forget to add your API key. In order 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

Name	Format	Example	Default value
apiKey	Alphanumeric string	`?apiKey=yourAPIkey` (fill in our onboarding form to receive your API key)	Not set
supportSell	Boolean value	`?supportSell=false`	true
defaultCrypto	Cryptocurrency code	`?defaultCrypto=BTC`	BTC
defaultFiat	Fiat code	`?defaultFiat=EUR`	USD
defaultAmount	Positive integer	`?defaultAmount=500`	100
wallets	Comma-separated list of crypto code:address;memo. Being `;memo` optional	`?wallets=BTC:btcaddr,BNB:binanceAddress;addressTag`	Not set
onlyCryptos	Comma-separated list of crypto codes	`?onlyCryptos=BTC,ETH,NEO`	Not set
excludeCryptos	Comma-separated list of crypto codes	`?excludeCryptos=BTC,ETH,NEO`	Not set
excludeFiat	Comma-separated list of fiat codes	`?excludeFiat=EUR,USD`	Not set
onlyFiat	Comma-separated list of fiat codes	`?onlyFiat=EUR,USD`	Not set
onlyGateways	Comma-separated list of gateway identifiers	`?onlyGateways=Wyre,Moonpay`	Not set
isAddressEditable	Boolean value	`?isAddressEditable=false`	true
isAmountEditable	Boolean value	`?isAmountEditable=false`	true
color	Hexadecimal color	`?color=346eeb`	31a5ff
fontFamily	font-family css string	`Arial, Helvetica, sans-serif`	'Roboto', sans-serif
partnerContext	URI encoded stringified JSON	`?partnerContext=${pContext}`	Not set
country	ISO 3166 alpha-2 code (eg: 'us', 'gb', 'es', 'all')	`?country=es`	Dynamic by client IP
language	ISO 639-1 language code (eg: 'en', 'ja', 'ko')	`?language=en`	en
darkMode	Boolean value	`?darkMode=true`	false
selectGatewayBy	string? (eg: 'performance', 'price')	`?selectGatewayBy=performance`	'price'

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={{
        width: "482px",
        height: "660px",
      }}
    >
      <OnramperWidget
        API_KEY={apiKey}
        color={defaultColor}
        fontFamily={fontFamily}
        defaultAddrs={wallets}
        defaultAmount={defaultAmount}
        defaultCrypto={defaultCrypto}
        defaultFiat={defaultFiat}
        defaultFiatSoft={defaultFiatSoft}
        defaultPaymentMethod={defaultPaymentMethod}
        filters={{
          onlyCryptos: onlyCryptos,
          excludeCryptos: excludeCryptos,
          onlyPaymentMethods: onlyPaymentMethods,
          excludePaymentMethods: excludePaymentMethods,
          excludeFiat: excludeFiat,
          onlyGateways: onlyGateways,
          onlyFiat: onlyFiat,
        }}
        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

Name	Type	Example	Default value
API_KEY	string?	`"yourAPIkey"` (fill in our onboarding form to receive your API key)	undefined
defaultCrypto	string?	`"ETH"`	undefined
defaultFiat	string?	`"EUR"`	"USD"
defaultAmount	number?	`500`	100
defaultAddrs	object?	`{"BTC": { address: "btcAddr" },"BNB": { address: "bnbAddress", memo: "cryptoTag" }}`	{}
filters	An object containing the attributes `onlyCryptos`, `excludeCryptos`, `onlyPaymentMethods`, `excludePaymentMethods`, `excludeFiat`, `onlyGateways` and `onlyFiat`.	`{filters:{onlyCryptos:["BTC", "ETH", "NEO"]}`	{}
onlyCryptos	string[]?	`["BTC", "ETH", "NEO"]`	undefined
excludeCryptos	string[]?	`["ETH", "NEO"]`	undefined
onlyFiat	string[]?	`["USD", "EUR"]`	undefined
excludeFiat	string[]?	`["USD"]`	undefined
onlyGateways	string[]?	`["Wyre", "Moonpay"]`	undefined
isAddressEditable	boolean?	`false`	true
isAmountEditable	boolean?	`false`	true
color	string?	`"#000000"`	"#31a5ff"
fontFamily	string?	`Arial, Helvetica, sans-serif`	'Roboto', sans-serif
darkMode	boolean?	`true`	false
selectGatewayBy	string? (eg: 'performance', 'price')	`?selectGatewayBy=performance`	'price'

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

Name	Type	Example	Default value
API_KEY	string?	`Onramper.initialize("#id", {API_KEY:"YourAPIkey"})` (fill in our onboarding form to receive your API key)	undefined
defaultCrypto	string?	`Onramper.initialize("#id", {defaultCrypto:"ETH"})`	undefined
defaultFiat	string?	`Onramper.initialize("#id", {defaultFiat:"EUR"})`	"USD"
defaultAmount	number?	`Onramper.initialize("#id", {defaultAmount:500"})`	100
defaultAddrs	object?	`Onramper.initialize("#id", {defaultAddrs:{"BTC": { address: "btcAddr" }}})`	{}
filters	An object containing the attributes `onlyCryptos`, `excludeCryptos`, `onlyPaymentMethods`, `excludePaymentMethods`, `excludeFiat`, `onlyGateways` and `onlyFiat`.	`Onramper.initialize("#id", {filters:{onlyCryptos:["BTC", "ETH", "NEO"]}})`	{}
onlyCryptos	string[]?	`Onramper.initialize("#id", {filters:{onlyCryptos:["BTC", "ETH", "NEO"]}})`	undefined
excludeCryptos	string[]?	`Onramper.initialize("#id",{filters:{excludeCryptos:["ETH", "NEO"]}})`	undefined
onlyFiat	string[]?	`Onramper.initialize("#id",{filters:{onlyFiat:["EUR"]}})`	undefined
excludeFiat	string[]?	`Onramper.initialize("#id", {filters:{excludeFiat:["EUR"]}})`	undefined
onlyGateways	string[]?	`Onramper.initialize("#id", {filters:{onlyGateways:["Moonpay"]}})`	undefined
isAddressEditable	boolean?	`Onramper.initialize("#id", {isAddressEditable:false"})`	true
isAmountEditable	boolean?	`Onramper.initialize("#id", {isAmountEditable:false})`	true
color	string?	`Onramper.initialize("#id", {color:"#000000"})`	"#31a5ff"
fontFamily	string?	`Onramper.initialize("#id", {fontFamily:"Arial, Helvetica, sans-serif"})`	"#31a5ff"
darkMode	boolean?	`Onramper.initialize("#id", {darkMode:true})`	false
selectGatewayBy	string? (eg: 'performance', 'price')	`Onramper.initialize("#id", {selectGatewayBy:"performance"})`	'price'

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.

Name	Description
API_KEY	Production or test API Key.
supportSell	Toggle sell option on the widget. Default value is `true`
defaultCrypto	Select a specific cryptocurrency by default. Should be specified the cryptocurrency code.
defaultFiat	Fiat currency to select by default.
defaultFiatSoft	Fiat currency to select by default only when the country currency is unavailable.
defaultPaymentMethod	A list of payment methods to prioritize and order the available payment methods (the first one available will be selected by default). See possible values here.
defaultAmount	Positive integer representing the base amount of fiat to be filled in the widget. Should be indicated in USD, for other currencies, a rounded aproximated conversion will be automatically applied.
minAmountEur	Positive integer representing the minimum amount of fiat to be filled in the widget. Should be indicated in EUR, for other currencies, a rounded aproximated conversion will be automatically applied.
defaultAddrs \| wallets	Used to autofill the crypto address of the user.
onlyCryptos	A comma-separated list of crypto codes to include. Only this cryptos will be shown to the user.
filters	An object containing the attributes `onlyCryptos`, `excludeCryptos`, `onlyPaymentMethods`, `excludePaymentMethods`, `excludeFiat`, `onlyGateways` and `onlyFiat`. Only for React/JS integrations.
excludeCryptos	A comma-separated list of crypto codes to exclude. This cryptos will be excluded from the list of available cryptos.
onlyFiat	Only the fiat currencies added here will be available to pick.
excludeFiat	The fiat currencies added here will be excluded from the available ones.
onlyPaymentMethods	Only the payment methods added here will be available to pick. See possible values here.
excludePaymentMethods	The payment methods added here will be excluded from the available ones. See possible values here.
onlyGateways	Only the gateways added here will be availables. By default all are availables.
isAddressEditable	Allow the user to edit the crypto address that is passed through the parameter defaultAddrs or wallets.
color	Color to change the highlight of the widget. Should be an hex color.
fontFamily	Font to use in the widget.
gFontPath	Allows you to load a remote Google Font. Eg. `css2?family=Roboto:wght@400;500&display=swap` widget.
redirectURL	URL to redirect the user once a transaction is finished. Should be encoded.
isAmountEditable	Allow the user to edit the amount (in fiat) which will be purchased. Setting this to false in conjunction with the defaultAmount parameter will only allow a user to purchase the amount specified.
recommendedCryptoCurrencies	Comma-separated list of crypto codes. The list specifies a group of items that should be shown first in the list of cryptocurrencies to choose
darkMode	Apply dark mode to the widget
selectGatewayBy	Choose the strategy by which a gateway is auto-selected (by price - the best exchange rate - or by performance - the gateway which has the most chance to complete a transaction given the selected country, crypto, and fiat currency)

Payment method IDs

IDs of all posible 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