Overview

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 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

Read the customer's credentials

Set up the buy button

Set up the widget

Add a card

Set up the Challenge frame

Get a transaction

List transactions

Delete a payment method

Verify a customer identity

Deprecated methods

These methods still work, but new integrations use client.setupBuyButton() instead. It renders the Apple Pay, Google Pay, or card button that matches the quote, or runs the purchase with no button when you pass headless: true.

Deprecated method	Replacement
`client.setupApplePay()`	`client.setupBuyButton()`
`client.setupGooglePay()`	`client.setupBuyButton()`
`client.setupBuy()`	`client.setupBuyButton({ headless: true })`

Customers

Payments

Integration essentials

SDK Reference

Frames

Overview

Install

Conventions

`Result<T, E>`

Function reference

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

Read the customer's credentials

Set up the buy button

Set up the widget

Add a card

Set up the Challenge frame

Get a transaction

List transactions

Delete a payment method

Verify a customer identity

Deprecated methods

​Install

​Conventions

​Result<T, E>

​Function reference

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

Read the customer's credentials

Set up the buy button

Set up the widget

Add a card

Set up the Challenge frame

Get a transaction

List transactions

Delete a payment method

Verify a customer identity

​Deprecated methods

Install

Conventions

`Result<T, E>`

Function reference

Deprecated methods