Skip to main content
Welcome to the Rampnow Quick Start Guide! This guide will walk you through integrating Rampnow’s on-ramp and off-ramp services into your platform.

​
Choose Your Integration Method

Rampnow offers three powerful integration options to seamlessly add cryptocurrency on/off-ramp services to your platform:

Hosted Mode Integration

Take full control of the user journey. The entire on/off ramp experience is managed by you, giving you complete customization and branding control.

Widget Mode Integration

Embed Rampnow’s on/off ramp directly into your application for a seamless, plug-and-play user experience with minimal setup.

Rampnow SDK

Install the @rampnow/sdk npm package for a developer-friendly integration with TypeScript support, event handling, and a React hook.
Both methods ensure your users can buy and sell cryptocurrencies effortlessly, with access to multiple payment options and supported assets.

​
Hosted Mode Integration

In hosted mode, you control the entire user journey through the on/off ramp process. This gives you maximum flexibility for customization and branding.

​
What is Hosted Mode?

Hosted mode allows you to integrate Rampnow’s services while maintaining complete control over the user interface and experience. Your users interact with your platform throughout the entire transaction flow.

​
Key Features

Design and customize every aspect of the user interface to match your brand identity and user experience standards.
Manage the entire transaction flow, from initiation to completion, within your own application environment.
Integrate Rampnow’s API endpoints directly into your backend systems for maximum flexibility.

​
Getting Started with Hosted Mode

1

Obtain API Credentials

Contact our sales team or log into the Partner Dashboard to generate your API keys and secret.
2

Set Up Authentication

Implement the authentication flow using your API credentials. See our Authentication Guide for details.
3

Integrate API Endpoints

Use our API endpoints to create quotes, initiate orders and track transaction status.
4

Build Your UI

Design and implement your custom user interface that calls our API endpoints.
5

Test in Sandbox

Thoroughly test your integration in our Sandbox environment before going live.

View Hosted Mode Documentation

Explore detailed documentation for Hosted Mode integration

​
Widget Mode Integration

Widget mode provides a pre-built, embeddable solution that you can add to your application with minimal code. Perfect for quick integration.

​
What is Widget Mode?

Widget mode offers a ready-to-use interface that you can embed directly into your application. Rampnow handles the UI and transaction flow while you maintain control over when and where the widget appears.

​
Key Features

Get up and running in minutes with just a few lines of code. No complex backend integration required.
Use our professionally designed, mobile-responsive interface that’s ready to go out of the box.
Benefit from automatic updates and improvements to the widget without any code changes on your end.
Customize colors, themes and branding to match your application’s look and feel.

​
Getting Started with Widget Mode

1

Get Your App Key

Obtain your unique App key from the Partner Dashboard.
2

Set Up the Container

Define a container element in your HTML where the widget will be embedded.
<div id="ramp-container"></div>
3

Create the Rampnow 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
4

Initialize the Widget

Initialize widget by passing the constructed Rampnow widget URL as below.
<iframe src="https://app.rampnow.io/order/quote?apiKey=YOUR_API_KEY&srcCurrency=EUR&srcAmount=250&dstCurrency=BTC&walletAddress=0xYourWalletAddress&dstCurrency=BTC" title="On Ramp"</iframe>

View Widget Mode Documentation

Explore detailed documentation for Widget Mode integration

​
Rampnow SDK

The Rampnow SDK is the recommended way to integrate the widget with full programmatic control, event handling, and TypeScript support.

​
What is the Rampnow SDK?

The @rampnow/sdk package wraps the widget integration into a developer-friendly JavaScript/TypeScript SDK. It supports overlay, embedded, and redirect modes, and ships with a React hook for seamless use in React applications.

​
Quick Example

import { RampnowSdk, RampnowEventType } from '@rampnow/sdk'

const sdk = new RampnowSdk({
  apiKey: 'pk_live_YOUR_API_KEY',
  srcCurrency: 'EUR',
  dstCurrency: 'ETH',
  walletAddress: '0xYourWalletAddress',
})

sdk
  .on(RampnowEventType.ORDER_COMPLETED, (e) => {
    console.log('Order completed:', e.payload.orderUid)
  })
  .init()

​
Key Features

Choose between Overlay (full-screen modal), Embedded (inline in your layout), or Redirect (URL for native apps and email links).
Subscribe to 13+ lifecycle events — order creation, payment status, KYC updates, errors, and more.
Use useRampnowSdk for idiomatic React integration with minimal boilerplate.
Full type definitions included out of the box for type-safe configuration and event handling.
Try the SDK live at demo.rampnow.io.

View SDK Documentation

Explore the full SDK reference — installation, configuration, events, and React integration

​
What’s Next?

API Reference

Explore our complete API documentation with endpoints, parameters and examples

Authentication

Learn how to securely authenticate your API requests

Supported Assets

View the complete list of supported cryptocurrencies and fiat currencies

Contact Sales

Have questions? Our team is here to help you get started
Need help? Contact our support team at [email protected] or visit our Help Center.