createClient()

Initialize a client with a sessionToken provided by your backend. The client is optional, but it gives you a single place to manage the integration credentials used across the SDK.

Initialize client

import { createClient } from "@moonpay/platform-sdk-web";

const client = createClient({ sessionToken: "c3N0XzAwMQ==" });

createClient() returns the client synchronously. Method calls on the client (for example, client.getConnection()) return a Result<T, E> you check before reading value.

Parameters

Property	Type	Required	Description
`sessionToken`	`string`	✅	The sessionToken created on your server.
`apiBaseUrl`	`string`		Override the MoonPay Platform API base URL. Defaults to production. Use this only when MoonPay support has asked you to point at a non-production environment.
`frameBaseUrl`	`string`		Override the MoonPay frame base URL. Defaults to production. Use this only when MoonPay support has asked you to point at a non-production environment.
`theme`	`object`		Styles every visible frame the SDK opens. See Theme.

Theme

Property	Type	Description
`theme.appearance`	`"dark"` \| `"light"`	Force a specific appearance in every visible frame. If you omit this, frames use the user’s system appearance.
`theme.brandColor`	`string`	Your brand color, such as `"FF6B00"`. Supported frames derive their whole palette from it. See Theming for the frames that apply it.
`theme.customTheme`	`object`	Border radius, color scheme, and palette overrides. Pass an object. The SDK serializes it. See Custom theme for the fields.

connect() accepts its own theme. Each option you set there overrides the same option here for the connect frame only.

Return value

createClient() returns a Client instance. It does not throw and does not return a Result.

`Client`

The client instance exposes every integration method:

client.getConnection()
client.connect()
client.setupAuth()
client.resetConnection()
client.getPaymentMethods()
client.deletePaymentMethod()
client.getQuote()
client.getTransaction()
client.listTransactions()
client.setupWidget()
client.setupBuyButton()
client.setupChallenge()
client.setupAddCard()
client.setupApplePay() (deprecated: use setupBuyButton())
client.setupGooglePay() (deprecated: use setupBuyButton())
client.setupBuy() (deprecated: use setupBuyButton() with headless: true)
Identity methods — createIdentity(), getIdentity(), updateIdentity(), verifyIdentity(), getIdentityUploadUrl(), submitIdentityFiles()

Overview

Customers

Payments

Integration essentials

SDK Reference

Frames

Parameters

Theme

Return value

`Client`

​Parameters

​Theme

​Return value

​Client

Parameters

Theme

Return value

`Client`