Overview

Use the Web SDK to build fiat-to-crypto ramps with headless payments.

The Web SDK targets first-party browser apps. It ships with TypeScript types for autocomplete and inference.

The SDK is tested against the latest versions of:

• Chrome (Desktop, iOS, Android)
• Safari (macOS)
• Safari (iOS)
• Firefox

Building a React Native app? Use the React Native SDK instead. For iOS, Android, or Flutter, drive frames directly — see the manual integration overview.

Install

Install the SDK package:

pnpm

pnpm i @moonpay/platform-sdk-web

bun add @moonpay/platform-sdk-web

npm i @moonpay/platform-sdk-web

Conventions

Result<T, E>

Most SDK functions return a Result<T, E> instead of throwing.

Field	Type	Required	Description
ok	boolean	✅	Whether the operation succeeded.
value	T		Present when ok is true.
error	E		Present when ok is false.

Use this pattern to branch on success vs failure:

const result = await someSdkCall();

if (!result.ok) {
  // Handle error
  console.error(result.error);
  return;
}

console.log(result.value);

Function reference

These pages document individual SDK functions, including parameters and return types:

Create a reusable client

Check the customer’s connection

Connect a customer

Authenticate with email and OTP

Reset the customer's connection

List payment methods

Get a quote

Set up Apple Pay

Set up Google Pay

Set up the widget

Set up the buy frame

Set up the buy button

Add a card

Set up the Challenge frame

Get a transaction

List transactions

Delete a payment method

Verify a customer identity