Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.moonpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
June 2, 2026
React Native SDK gained resetConnection() and deletePaymentMethod() — the resetConnection() method runs the reset frame in a hidden WebView so you can clear the customer’s MoonPay connection on sign-out, mirroring the Web SDK behavior. deletePaymentMethod() removes a stored card by its id. Requires @moonpay/platform-sdk-react-native 0.3.0 or later.
​
June 1, 2026
Challenges and quotes docs corrected — refreshed the guides and SDK reference to match how the SDK and API actually behave:
  • Handle challenges is now a flow-agnostic guide. Challenges are surfaced by frames — today the Apple Pay, Google Pay, and buy (Pay with card) frames each emit a challenge event whose URL is loaded into the dedicated Challenge frame. The old example showing challenge nested inside a quote response was incorrect and has been removed.
  • Core concepts → Quotes no longer describes “price quotes” and “executable quotes” as two types. There is a single quote with an executable boolean — see the quotes API reference for the request fields required to receive executable: true.
  • The per-flow guides (Apple Pay, Google Pay) and the getQuote / setup-method SDK reference pages now use this single-quote framing.
​
May 28, 2026
React Native SDK reference — added a full reference for @moonpay/platform-sdk-react-native under SDK reference → React Native SDK. Covers the MoonPayProvider and the useMoonPay() hook, plus per-method pages for getConnection, connect, getPaymentMethods, getQuote, setupWidget, setupApplePay, setupGooglePay, setupBuy, setupBuyButton, setupAddCard, setupChallenge, getTransaction, and listTransactions. The SDK uses react-native-webview to render MoonPay frames in your React Native app.Challenge frame docs cover the identity flow — updated the Challenge frame reference so the complete, cancelled, and error payloads describe both upstream flows (buy and identity):
  • complete and cancelled payloads are now documented as discriminated unions over flow: "buy" | "identity". The identity variant carries identityId on complete and no extra fields on cancelled.
  • error codes refreshed to match the frame’s wire format (invalid_token, unsupported_flow, invalid_challenge) and the payload type loosened to code: string to reflect that additional codes can be propagated from the upstream flow.
​
May 26, 2026
Web SDK reference synced with @moonpay/platform-sdk-web — rewrote every page under SDK reference → Web SDK against the current SDK source. Highlights:
  • Corrected the package name across all code samples (@moonpay/platform → @moonpay/platform-sdk-web).
  • createClient() now correctly returns a Client directly (previously documented as a Result).
  • API error tables for getQuote, getPaymentMethods, deletePaymentMethod, getTransaction, and listTransactions now show the real DevPlatformApiError shape (code + message + optional errors[]), and success shapes use the correct { data } / { data, pageInfo } envelopes.
  • getConnection documents the full set of connection statuses (including termsAcceptanceRequired) and CustomerCapabilities.
  • setupApplePay error and event unions now match the SDK — added oneTapApplePaySecondFactorRequired and removed a fabricated challenge event.
  • setupAddCard, setupBuy, setupWidget, setupGooglePay, and setupChallenge had their event payloads, FrameTransaction shape, and option tables corrected.
New SDK reference pages — added resetConnection and setupBuyButton, and wired the whole SDK reference section into the Platform sidebar.Frame theming: every frame now accepts a brandColor URL parameter that seeds a runtime-derived palette across the entire UI, plus an optional customTheme for border radius, color scheme lock, and granular palette control. See the new theming guide for accepted formats and examples per frame.
​
May 25, 2026
Buy frame SDK reference — added the setupBuy SDK method reference, documenting parameters (including the optional externalTransactionId), BuyEvent variants, the BuyFrame.setQuote/dispose return shape, and the SetupBuyError type. Includes guidance on rendering a separate challenge frame when a challenge event fires.Add Card SDK reference — added the setupAddCard SDK method reference, documenting parameters, AddCardEvent variants, the CardResponse shape returned on completion, and SetupAddCardError. Notes that the frame renders immediately and does not emit a ready event.Challenge frame SDK reference — added the setupChallenge SDK method reference, documenting the url parameter (sourced from upstream challenge events), the flow-discriminated complete and cancelled payloads, the self-driving frame behavior, and SetupChallengeError. Links to the Handling Challenges guide for the full flow.Transaction SDK reference — added SDK reference pages for getTransaction and listTransactions. Each documents parameters, the Result envelope, key Transaction fields, and the DevPlatformApiError shape, with usage examples for polling terminal status and paginating through results.Delete payment method SDK reference — added the deletePaymentMethod SDK method reference, documenting the paymentMethodId parameter, the Result<undefined, DeletePaymentMethodError> return (no body on success), and the standard API error shape.
​
May 22, 2026
setupGooglePay reference accuracy — corrected the setupGooglePay SDK reference to match the shipped Google Pay SDK: added the externalTransactionId option, included the kind: "frame" discriminator on the challenge event payload, and aligned the GooglePayEventError and SetupGooglePayError kind unions with the values the SDK actually emits. Google Pay unavailability is surfaced through the "unsupported" event rather than as an error.Widget SDK reference — added the setupWidget SDK method reference, documenting parameters, events, and return type for the MoonPay buy widget.
​
May 21, 2026
Challenge events for Apple Pay and Google Pay — the Apple Pay frame and Google Pay frame now emit a challenge event when verification is required before a transaction can proceed. Challenge handling added to the Apple Pay SDK reference, Google Pay SDK reference, and manual integration guides for web, iOS, React Native, and Flutter.TransactionStatus fix — corrected the TransactionStatus enum value from complete to completed in the Apple Pay frame and Google Pay frame references.
​
May 20, 2026
Google Pay — new Pay with Google Pay guide, Google Pay frame reference, and setupGooglePay SDK method. Covers the standalone Google Pay frame integration and manual integration for web, Android, React Native, and Flutter.
​
May 19, 2026
EEA disclosures — published the exact verbiage required above the Apple Pay frame and the card Pay button for customers located in the EEA, with separate text for standard crypto-assets and non-MiCA-compliant stablecoins (USDT, cUSD, DAI, PYUSD). See Going Live.
​
May 18, 2026
API key header — server-to-server requests now authenticate with the X-Api-Key header. See Using the Platform API and API and SDK credentials.
​
May 13, 2026
Payment-disclosure geography — paymentDisclosures now identifies the customer’s geography. country is the ISO 3166-1 alpha-3 code, administrativeArea is included for US state-level disclosures, and area can identify broader regions such as "EEA".
​
May 12, 2026
Going Live — documented the acceptance criteria for the global rollout (except UK). Each requirement is now tagged with a geo, and new sections cover Cards, Identity API, and EEA Apple Pay disclosures (verbiage pending). See Going Live.
​
May 8, 2026
Preview removed — the Developer Platform is now generally available. The “currently in preview” notice has been removed from all docs pages.
​
May 8, 2026
Card payments — new Pay with card guide and frame references for Add Card, Buy, and Challenge. Covers the full integration: listing and managing stored cards, getting a card quote, executing transactions via the headless buy frame, and handling verification challenges (SCA, 3DS, CVC re-entry, KYC). Also adds the Delete payment method API endpoint.
​
May 5, 2026
Reset frame — new headless frame at /platform/v1/reset that lets you log a customer out by clearing their authentication state on MoonPay’s domain. Reports completion via postMessage. See Reset.
​
May 5, 2026
Unified docs site — Platform and Widget docs now live under a single Mintlify site with separate top-level tabs. Legacy /overview/*, /guides/*, /frames/*, /sdk-reference/*, and /api-reference/* URLs redirect to their new /platform/* paths.
​
May 1, 2026
Manual integration fixes — corrected the WebView samples to post the payload as a string, base64-decode credentials, and handle JS dialogs. Affects web, iOS, Android, React Native, and Flutter guides.
​
May 1, 2026
Fee language updated across guides to clarify partner vs. ecosystem fees.
​
April 30, 2026
Revoke session — DELETE /platform/v1/sessions invalidates an active session token. See Revoke a session.
​
April 29, 2026
Sessions endpoint renamed — POST /platform/v1/session is now POST /platform/v1/sessions (plural). The old path continues to work; new integrations should use the plural form.
​
April 28, 2026
Apple Pay going-live guide — added production-readiness details for the Apple Pay frame, including merchant verification and domain registration steps. See Pay with Apple Pay.
​
April 27, 2026
customerId in connect/check payload — the complete postMessage event now documents customer.id, and the session-create request documents the customerId field for returning users (skip the connect flow when you already have one).
​
April 20, 2026
Manual integration credentials — the manual integration guides now use clientToken (not sessionToken) to initialize frames, matching the early-credential-issuance flow.
​
April 17, 2026
US payment-disclosure rails narrowed — the paymentDisclosures capability is now documented as scoped to NY and WA within the US. Customers in other US states will not receive a paymentDisclosures requirement.
​
April 17, 2026
HKDF examples — manual integration code samples consistently pass undefined for the info parameter of hkdf().
​
April 10, 2026
Acceptance criteria page — new compliance checklist outlining the requirements for going live. See Going live.
​
April 10, 2026
Manual integration moved — the per-platform manual integration pages now live under Guides → Manual Integration.
​
April 10, 2026
Using agents — new page covering MCP client setup for Claude Code and Codex, so you can wire your agent to MoonPay’s developer docs. See Using agents.
​
April 10, 2026
Manual integration docs — initial documented integrations for web, iOS, Android, React Native, and Flutter (graduated from hidden drafts).
​
April 9, 2026
Early credential issuance — the credentials-flow guide now reflects that clientToken and accessToken are issued before authentication completes, so partners can initialize sensitive frames sooner.
​
April 9, 2026
Connect-flow low-friction callout — added guidance to the connect-flow guide about minimizing handoffs back to MoonPay-hosted UI.
​
April 9, 2026
Apple Pay frame height — corrected the documented frame height for the Apple Pay frame.
​
March 2026
Quote API: fees.partner field renamed to fees.ecosystem.Apple Pay: documented test-mode and frame sandbox requirements, plus a corrected frame size.Customer capabilities and payment-disclosure requirements expanded.New widget-fallback frame and integration guide.Frames protocol: documented version: 2 and added the versioning section.Frame URLs migrated from /v2/* to /platform/* across all docs.
​
February 2026
OpenAPI now served live from https://api.moonpay.com/platform/openapi.json rather than checked into the repo.Removed historical pk_test / pk_live references in favor of the new credential model.Initial Apple Pay frame size and frame sandbox requirements published.Mintlify upgrade and a content-style-guide pass across guides and frames docs.