FloPay

FloPay is a payment orchestration platform. These docs cover the main ways to work with Flo: the REST API, the Playground, the JavaScript and React SDKs, the Node SDK, and the webhook contract clients receive from Flo.

Use Flo when you want a consistent payment surface for checkout, subscriptions, invoices, and webhook-driven automation without coupling your application to a single gateway.

REST API

The Flo REST API is the server-side surface for creating and managing Flo resources directly.

Use it when you want to:

• create checkout sessions from your backend
• manage client webhook endpoints and review delivery events
• build integrations in non-JavaScript stacks
• work directly with Flo resources outside the SDKs

Open the REST API docs

Playground

The Playground is the fastest way to explore Flo in a hosted environment before wiring up your own frontend or backend.

Use it to:

• understand the checkout flow end to end
• see how Flo concepts map to real user journeys
• validate integration expectations before implementation

Open the Playground

FloPay SDK

The SDK packages are the frontend and Node integration layer for teams that want higher-level primitives on top of the Flo platform.

Packages

The SDK is split into four packages:

Key Features

• Provider-agnostic adapter pattern -- swap from Stripe to another provider without changing your integration code
• REST API and SDK coverage -- integrate through direct API calls, frontend SDKs, or a mixed model
• Embedded one-shot checkout -- FloPayCheckout can create the session inline and render the payment form in one component
• Automatic payment buttons -- FloPayAutomaticPaymentButton wraps saved-payment purchases in the same processing / success / decline modal used by checkout
• Self-contained checkout forms -- CheckoutForm and SplitCardForm handle the full payment lifecycle (tokenize, create intent, confirm, process, 3DS retry) out of the box
• 3D Secure handled automatically -- both forms detect 3ds_required responses and trigger the authentication flow transparently
• PayPal support -- SplitCardForm renders a PayPal button alongside card fields with a separate Elements instance, matching Stripe's architecture requirements
• Built-in theming -- three bundled themes (default, flat, night) with customizable CSS variables
• Structured errors -- FloPayError provides typed error categories (validation_error, api_error, network_error, etc.) with factory helpers

How It Works

Your App or Backend
  |
  +--> Flo REST API
  |
  +--> FloPay SDKs
  |       |
  |       +--> FloPayCheckout
  |
  +--> Flo Playground (for exploration and demo flows)
  |
  v
Flo Platform  -->  Gateway Adapters  -->  Payment Gateways
  |
  +--> Webhooks  -->  Your Backend

1. Choose your surface -- use the REST API, the SDKs, or both
2. Configure -- set the FloPay environment and your client ID
3. Render -- drop in <FloPayCheckout createSession={...} /> for the embedded one-shot flow
4. Pay -- Flo creates the session, initializes the active gateway, and renders the payment form
5. Complete -- use onComplete on the client and webhooks on the server as needed

Next Steps

• REST API Docs -- explore the server-side API
• Playground -- try Flo in a hosted demo environment
• Installation -- set up your project
• React Quick Start -- build your first embedded checkout
• Node.js Quick Start -- add webhook handling for embedded checkout
• Concepts -- understand the architecture
• Terminology -- align on Flo terms