Introduction
Reference for the XPay client SDKs. The integrate guides cover how to use them; this tab lists every public symbol.
XPay ships two official client libraries today: a JavaScript loader for the browser and a thin React wrapper that builds on top of it. This tab is a reference for what each package exports, the function signatures, and the option types. For walkthroughs of how to integrate each pattern (Drop-in, Elements, Hosted Checkout, Payment Links), see Integration patterns under the Integrate tab.
Pick the right package
JavaScript SDK
@xpay/sdk-js. The browser SDK loader, factory, Elements, drop-in checkout, and types. Use this directly if you're not on React.
React SDK
@xpay/sdk-react. XPayProvider, hooks (useCheckout, useXPay, useElements, useConfirmPayment), <PaymentElement />, <CheckoutButton />. Wraps the JS SDK for React apps.
Mobile
iOS / Android / React Native SDKs are not yet shipped. Placeholder for when they land.
What this tab is for
The pages under this tab are reference pages. Every public export of each package gets one section, with its signature and a minimum example. They're optimized for lookup, not learning.
- For a guided walkthrough on Drop-in checkout: Drop-in pattern.
- For a guided walkthrough on Elements: Elements pattern.
- For the Hosted Checkout pattern (no SDK needed): Hosted Checkout.
- For Payment Links (no code at all): Payment Links.