Hosted Mode Integration

The Hosted Page method is the simplest and fastest way to integrate Rampnow’s services. You don’t need to handle any complex front-end development or embed anything directly into your platform. Instead, users are redirected to a fully hosted Rampnow page to complete their transactions, and you can easily track their progress.

Steps to Implement Hosted Page Integration:

Generate a Hosted Page URL:
You will need to create a URL that includes your API key and necessary parameters, such as the cryptocurrency, amount, and user's wallet address.

Example URL format:

https://app.rampnow.io/order/quote?apiKey=YOUR_API_KEY&srcCurrency=EUR&dstCurrency=ETH&srcAmount=100&walletAddress=0xYourWalletAddress&paymentMode=card

Redirect the User:
When users on your platform want to buy or sell crypto, simply redirect them to the generated URL. They will be taken to the Rampnow hosted page where they can complete their transaction.
Receive Webhook Notifications (Optional):
To track transaction status, you can set up webhooks in your Rampnow Partner Dashboard. This will allow you to receive real-time notifications when users complete their transactions.

Webhook setup documentation can be found in our API Documentation.

Benefits of Hosted Page Integration:

Fast Setup: Minimal development required.
Security: All user data and transactions are handled securely on Rampnow’s platform.
Customizable: The hosted page can be partially branded to align with your platform.

Ideal For:

Platforms looking for a quick solution with minimal integration.
Teams without extensive front-end development resources.

Passing Parameters in the URL for Hosted ModeCopied!

When using the Hosted Mode integration, you can customize the experience for your users by passing specific parameters in the URL. These parameters control things like the cryptocurrency to be purchased, the amount, the user's wallet address, and other key details. This allows you to create a personalized experience for each user when they are redirected to the Rampnow hosted page.

URL Structure

The base URL for the hosted page is:

https://app.rampnow.io/

You can append the necessary parameters to this URL to tailor the transaction. Here’s an example of a fully-formed URL:

https://app.rampnow.io/order/quote?apiKey=YOUR_API_KEY&currency=ETH&amount=100&walletAddress=0xYourWalletAddress

Common Parameters

Here are the parameters that you can pass in the URL:

Parameter	Required	Default Value	Description
apiKey	Required		This is your unique API key, which is available in your Rampnow Partner Dashboard. It authorizes your platform to use Rampnow services Example: `apiKey=YOUR_API_KEY`
orderType	Optional	buy
srcChain	Required	buy - fiat sell - ethereum	That chain corresponding to the asset that the user is willing to spend. In case of buy `srcChain` will be `fiat` , in case of sell, it is crypto currency Example: `srcChain=ethereum`
srcCurrency	Required	buy - EUR sell - ETH	The currency that the user is willing to spend. For buy order type, the `srcCurrency` is fiat currencies and for sell, it is crypto currency Example: `srcCurrency=ETH`
srcAmount	Required	100 EUR value in `srcCurrency`	This defines the amount in `srcCurrency` the user is willing to spend. You can set a default value, and users will be able to adjust it on the hosted page if needed. Example: `srcAmount=100` (This example means 100 EUR will be the order amount
dstCurrency	Optional	buy - ETH sell - EUR	The currency that the user will receive after order completion. For buy, the `dstCurrency` is in crypto and for sell, it is fiat currency. Example: `dstCurrency=ETH`
dstChain	Required	buy - ethereum sell - fiat	The chain corresponding to the currency that the user will receive after order completion. For buy, the `dstChain` is in crypto and for sell, it is fiat currency. Example: `dstChain=ethereum`
paymentMode	Optional	Payment mode with lowest fee	Allowed payment modes `[card, google_pay, apple_pay, sofort, open_banking, pix, sepa]`
walletAddress	Optional		The user's cryptocurrency wallet address where the purchased crypto will be sent. This ensures that the user doesn’t have to manually enter their wallet address on the hosted page. Example: `walletAddress=0xYourWalletAddress`
walletAddressTag	Optional		Optional wallet tag/memo for supported chains
externalOrderId	Optional		Client Order id

Example Full URL

Here’s an example of a full URL with all the parameters:

https://app.rampnow.io/order/quote?apiKey=YOUR_API_KEY&srcCurrency=EUR&srcAmount=250&dstCurrency=BTC&walletAddress=0xYourWalletAddress&dstCurrency=BTC

In this example:

The user is buying 250 EUR worth of BTC.
The crypto will be sent to the wallet address 0xYourWalletAddress.
The transaction will be made in USD.
The user's email user@example.com is pre-filled.
The hosted page displays "YourApp" as the host and shows the logo from https://yourapp.com/logo.png.