SDK Installation & Setup

Install

npm install @rampnow/sdk

yarn add @rampnow/sdk

pnpm add @rampnow/sdk

CDN (no bundler):

<script src="https://cdn.jsdelivr.net/npm/@rampnow/sdk/dist/rampnow-sdk.umd.js"></script>

When loaded from the CDN, the SDK is available as window.RampnowSdk.

Environments

The SDK opens production by default. Set widgetUrl to the sandbox host while you build and test.

Environment	Widget host	Key
Sandbox	`https://app.sandbox.rampnow.io`	Sandbox public key
Production	`https://app.rampnow.io`	Production public key

Build and test against sandbox first. No real money or mainnet crypto moves there. See Sandbox Testing for test payments and testnet tokens.

Open your first session

Create an instance

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',
  dstCurrency: 'ETH',
  dstChain: 'ethereum',
})

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',
  dstCurrency: 'EUR',
  dstChain: 'fiat',
})

Every option is listed in Configuration.

Subscribe to events

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

See Events & commands for the full list.

Open the widget

sdk.init()

Without containerId this opens a full-screen overlay. See Display modes for embedded and redirect.

React

The SDK ships with a React hook.

React (>=18) and ReactDOM (>=18) are optional peer dependencies, only required when you use the hook.

import { useRampnowSdk } from '@rampnow/sdk/react'
import { RampnowEventType } from '@rampnow/sdk'
import { useEffect } from 'react'

function BuyCryptoButton() {
  const { init, close, send, on, isOpen } = useRampnowSdk({
    apiKey: 'pk_YOUR_API_KEY',
    srcCurrency: 'EUR',
    dstCurrency: 'ETH',
  })

  useEffect(() => {
    on(RampnowEventType.ORDER_COMPLETED, (e) => {
      console.log('Completed:', e.payload.orderUid)
      close()
    })
  }, [on, close])

  return <button onClick={init}>{isOpen ? 'Loading…' : 'Buy Crypto'}</button>
}

The hook returns the same init, close, send, on and isOpen as an SDK instance.

Methods

`new RampnowSdk(config)`

Creates an SDK instance. Validates the apiKey and merges defaults. Does not open the widget; call .init() to display it.

`sdk.init(): RampnowSdk`

Opens the widget. If containerId is set, mounts the iframe in that element; otherwise creates a full-screen overlay. Returns this for chaining.

`sdk.close(): void`

Closes and removes the widget from the DOM.

`sdk.on(eventType, callback): RampnowSdk` / `sdk.off(eventType, callback): RampnowSdk`

Subscribe to and unsubscribe from widget events. See Events.

`sdk.send(commandType, payload): RampnowSdk`

Send a command to the widget iframe. See Commands.

`sdk.isOpen: boolean`

Read-only. Whether the widget is currently displayed.

`RampnowSdk.createRedirectUrl(config): string` (static)

Builds a full widget URL from config without opening an iframe. See Redirect mode.

Next: Configuration

Every option you can pass to the SDK

Build with AI

Learn about Rampnow

What's Supported

Integrations

Help

SDK Installation & Setup

Install

Environments

Open your first session

React

Methods

`new RampnowSdk(config)`

`sdk.init(): RampnowSdk`

`sdk.close(): void`

`sdk.on(eventType, callback): RampnowSdk` / `sdk.off(eventType, callback): RampnowSdk`

`sdk.send(commandType, payload): RampnowSdk`

`sdk.isOpen: boolean`

`RampnowSdk.createRedirectUrl(config): string` (static)

Next: Configuration

​Install

​Environments

​Open your first session

​React

​Methods

​new RampnowSdk(config)

​sdk.init(): RampnowSdk

​sdk.close(): void

​sdk.on(eventType, callback): RampnowSdk / sdk.off(eventType, callback): RampnowSdk

​sdk.send(commandType, payload): RampnowSdk

​sdk.isOpen: boolean

​RampnowSdk.createRedirectUrl(config): string (static)

Next: Configuration

Install

Environments

Open your first session

React

Methods

`new RampnowSdk(config)`

`sdk.init(): RampnowSdk`

`sdk.close(): void`

`sdk.on(eventType, callback): RampnowSdk` / `sdk.off(eventType, callback): RampnowSdk`

`sdk.send(commandType, payload): RampnowSdk`

`sdk.isOpen: boolean`

`RampnowSdk.createRedirectUrl(config): string` (static)