Onramp & Offramp SDK Quickstart

The SDK opens the widget as an overlay, with typed config and browser events. No backend or signing needed. Set orderType to buy (onramp) or sell (offramp). Examples run against sandbox.

Using an AI coding agent? Connect it to these docs first: Build with AI.

Install

npm install @rampnow/sdk

pnpm add @rampnow/sdk

Create the SDK

Use your public key (pk_...) from the Partner Dashboard under API Hub.

Onramp (buy)
Offramp (sell)

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

const sdk = new RampnowSdk({
  apiKey: 'pk_YOUR_API_KEY',
  widgetUrl: 'https://app.sandbox.rampnow.io',
  orderType: 'buy',
  srcCurrency: 'EUR',
  srcChain: 'fiat',
  srcAmount: '250',
  dstCurrency: 'ETH',
  dstChain: 'ethereum',
  walletAddress: '0xUserWalletAddress',
})

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

const sdk = new RampnowSdk({
  apiKey: 'pk_YOUR_API_KEY',
  widgetUrl: 'https://app.sandbox.rampnow.io',
  orderType: 'sell',
  srcCurrency: 'USDT',
  srcChain: 'ethereum',
  srcAmount: '500',
  dstCurrency: 'EUR',
  dstChain: 'fiat',
})

Drop widgetUrl in production; it defaults to https://app.rampnow.io.

Listen and open

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

sdk.init()

Receive webhooks

Add your webhook URL in the Partner Dashboard under API Hub. Rampnow posts on every order status change. See Webhook.

Full guide

Embedded and redirect modes, every event, commands and the React hook