<aside> 💡 This guide contains steps to integrate the Rampay widget in your website/app

</aside>

Steps

• Get an API key by contacting us. Our contact info is mentioned here
• Place the widget inside an iframe on your website/app.

<iframe
      src="<https://exchange.rampay.io>
        ?apiKey={PARTNER_API_KEY}"
      width="50%"
      height="100%"
>
		Your browser does not support iframes.
</iframe>

• We are also working on a partner dashboard where partners would be able to see all orders placed through their platform.

Ways to customise widget

The widget is customisable in a lot of ways.

The customisation options can be passed as query params with the widget link in src tag of iframe. For eg. below example will always open up the widget with default selected fiat currency as US dollars and cryptocurrency as Bitcoin.

<iframe
      src="<https://exchange.rampay.io>
        ?from=usd&to=btc"
      width="50%"
      height="100%"
>
		Your browser does not support iframes.
</iframe>

More query params to customise widget

Following list contains all the possible query params that can be used to customise the widget.

• apiKey
  • API key unique to each partner.
  • Sample: apiKey=5b3b5af4-c9cd-4fc3-88b9-ec6aca28d6f2
  • Default: empty
• to
  • Default selected crypto currency to show when widget loads
  • Sample: to=btc
  • Default: eth
• from
  • Default selected fiat currency to show when widget loads
  • Sample: from=gbp
  • Default: usd
• amt
  • Default amount of fiat currency to show when widget loads
  • Sample: amt=1000
  • Default: 200
• walletAddress
  • Comma separated values of wallet addresses in case you want to prefill wallet address when user tries to buy crypto
  • Follow the format <crypto code>:<wallet address>
  • Sample: walletAddress=btc:0x43rwerlknwenrlekwnrewlnkr,eth:0x34kwmrkwernjnrs4k435kmk4432glfd . In this case, whenever the selected currencies in the widget are btc or eth the provided wallet address would prefill in the wallet address field in the transaction flow.
  • Default: empty
• primaryColor
  • Hexcode of color theme for sdk. Like button color etc.
  • Sample: primaryColor=4a88ce
  • Default: 1D0458
• cl
  • cl stands for crypto list. Comma separated list of crypto currencies if you only want to show a subset of available cryptocurrencies.
  • Sample: cl=btc,eth
  • Defaults to empty in which case we show all currencies