FloPay Docs

Split card checkout form with separate card number, expiry, CVC fields, name input, and optional PayPal button.

SplitCardForm

Split card checkout form that renders individual card fields (CardNumber, CardExpiry, CardCVC), a full name input, and an optional PayPal button. Matches the checkout/StripeCardForm layout.

const SplitCardForm: React.ForwardRefExoticComponent<
  SplitCardFormProps & React.RefAttributes<SplitCardFormRef>
>

Props

Name	Type	Required	Default	Description
`sessionId`	`string`	Yes	--	Checkout session ID (UUID from billing API).
`billingApiUrl`	`string`	Yes	--	Billing API base URL.
`email`	`string`	No	--	User's email (required for creating payment intents).
`userId`	`string`	No	--	User ID (required for processing payments).
`onComplete`	`(result: PaymentResult) => void`	No	--	Called when payment completes successfully.
`onError`	`(error: FloPayError) => void`	No	--	Called when a payment error occurs.
`onDecline`	`(decline: DeclineEvent) => void`	No	--	Called when a payment is declined, authentication fails, PayPal is cancelled, or a wallet sheet is dismissed.
`onTokenizedBody`	`(tokenizedBody: TokenizedBody) => void`	No	--	Override: delegates backend submission to the caller.
`firstName`	`string`	No	--	First name for billing.
`lastName`	`string`	No	--	Last name for billing.
`chv`	`string`	No	--	Checkout version for A/B tracking.
`submitLabel`	`string`	No	`'CONFIRM PAYMENT'`	Label for the submit button.
`className`	`string`	No	--	Additional CSS class for the form wrapper.
`children`	`React.ReactNode`	No	--	Custom children (overrides default submit button).
`isProcessing`	`boolean`	No	--	External processing state.
`error`	`string \| null`	No	--	External error message.
`onErrorChange`	`(error: string \| null) => void`	No	--	Called when internal error state changes.
`onFullNameChange`	`(value: string) => void`	No	--	Callback when the full cardholder name input changes.
`onFirstNameChange`	`(value: string) => void`	No	--	Callback when first name changes (parsed from full name input).
`onLastNameChange`	`(value: string) => void`	No	--	Callback when last name changes (parsed from full name input).
`showStripe`	`boolean`	No	`true`	Render the Stripe gateway. When `false`, the entire Stripe panel is hidden — card fields, Apple Pay, Google Pay, and every other Stripe-enabled payment method. When `true` (default), each method enabled on the connected Stripe account renders dynamically. See Stripe payment methods.
`showPayPal`	`boolean`	No	`true`	Render the PayPal gateway above card fields. When `false`, both the direct PayPal and PayPal via Stripe paths are hidden.
`layout`	`'default' \| 'buttons'`	No	`'default'`	Layout mode. `'buttons'` shows payment method buttons with an expandable card form.
`theme`	`ThemeId`	No	--	Single-prop theming. Styles both the Stripe-side appearance and the React-rendered wrapper, submit, and inputs from one value. Available across `FloPayCheckout`, `FloPayAutomaticPaymentButton`, and `SplitCardForm`.
`appearance`	`FloPayAppearance`	No	--	Stripe-side appearance overrides (palette + nested-element `rules`). Wins over a `theme` bundle's appearance. When supplied without `buttonsStyles`, the wrapper, submit, title, input, and font styling derive from `appearance.variables`.
`buttonsStyles`	`ButtonsLayoutStyles`	No	--	Per-field style overrides merged on top of the resolved `theme` bundle. Painted regardless of `layout="default"` or `layout="buttons"`.
`buttonsTheme`	`ButtonsLayoutTheme`	No	--	Deprecated. Legacy preset (`'default' \| 'minimal' \| 'rounded' \| 'dark'`) still resolved via `resolveButtonsLayoutTheme()` for back-compat. Prefer `theme`.
`cardButtonContent`	`React.ReactNode`	No	--	Replaces the default content inside the card button when `layout="buttons"`.
`cardBackButtonContent`	`React.ReactNode`	No	--	Replaces the default "Go back" label in the expanded card form when `layout="buttons"`. Pass `''` to remove the text and keep only the icon.
`cardTitleContent`	`React.ReactNode`	No	--	Replaces the default "Secure card checkout" title. Pass `''` to remove the title text entirely.
`onButtonClick`	`(method: CheckoutButtonMethod) => void`	No	--	Called when a payment method button is clicked. Fires on the initial click for `'card'` (buttons layout), `'paypal'`, `'apple_pay'`, `'google_pay'` — before PayPal redirect or wallet authorization. Cancelled if `onBeforeButtonClick` returns `false`.
`onBeforeButtonClick`	`(event: BeforeButtonClickEvent) => void \| false \| InlineSessionPatch \| Promise<...>`	No	--	Card only. Runs before the "Credit / Debit Card" button continues in `layout="buttons"`. Returning `false` cancels the click.
`enableAVS`	`boolean \| AVSFieldConfig`	No	`false`	Enable AVS. `true` → country + postal code (legacy default). An `AVSFieldConfig` object enables per-field, per-country control of country, postal code, street address, city, and state. See AVS guide.
`avsLayout`	`'row' \| 'column'`	No	`'row'`	Layout for the country / postal code pair. Address line, city, and state always render on their own rows.
`country`	`string`	No	`'US'`	Pre-filled country code (ISO 3166-1 alpha-2). Typically from a partner GEO/IP lookup.
`zip`	`string`	No	—	Pre-filled ZIP/postal code.
`city`	`string`	No	—	Pre-filled city. Typically from a partner GEO/IP lookup.
`state`	`string`	No	—	Pre-filled state/province. Typically from a partner GEO/IP lookup.
`addressLine1`	`string`	No	—	Pre-filled street address (line 1).
`addressLine2`	`string`	No	—	Pre-filled apt/suite/unit (line 2).
`onCountryChange`	`(country: string) => void`	No	—	Callback when country changes.
`onZipChange`	`(zip: string) => void`	No	—	Callback when ZIP/postal code changes.
`totalAmount`	`number`	No	`0`	Total amount in cents (used for wallet/PayPal Elements config).
`currency`	`string`	No	`'usd'`	Currency code (used for PayPal Elements config).
`debug`	`boolean`	No	`false`	Render diagnostic panels showing resolved payment methods and the Direct PayPal button lifecycle. Forwarded to each `DirectPayPalButton` render site. Intended for local development — leave off in production.

SplitCardFormRef

Methods exposed via ref for external 3DS handling.

Method	Signature	Description
`handleNextAction`	`(clientSecret: string) => Promise<void>`	Trigger 3DS authentication with the given client secret.

Default Layout

The default layout renders all payment methods and card fields together:

Wallet buttons (Apple Pay / Google Pay)
PayPal button
"or pay with card" divider
Card Number field
Card Expiry + CVC fields (side by side)
Full Name input
Error display
Submit button

Buttons Layout

When layout="buttons", payment methods are shown as stacked buttons:

PayPal button
Wallet buttons (Apple Pay / Google Pay)
"Credit / Debit Card" button

Clicking the card button expands into the card form with a configurable back button label and title. PayPal and wallet buttons stay mounted (no re-render) and are hidden via CSS.

onBeforeButtonClick is credit card only. It runs only for the "Credit / Debit Card" button in layout="buttons". It does not run for PayPal, Apple Pay, or Google Pay.

<SplitCardForm
  sessionId={sessionId}
  billingApiUrl="https://api.flopay.com"
  email={email}
  layout="buttons"
  theme="modern-light"
/>

You can replace the default card button body with any React content:

<SplitCardForm
  sessionId={sessionId}
  billingApiUrl="https://api.flopay.com"
  email={email}
  layout="buttons"
  cardButtonContent={
    <div style={{ display: 'flex', alignItems: 'center', width: '100%' }}>
      <span style={{ fontWeight: 700 }}>Pay by card</span>
      <span style={{ marginLeft: 'auto', opacity: 0.7 }}>Secure</span>
    </div>
  }
/>

You can also replace or remove the header text in the expanded card form:

<SplitCardForm
  sessionId={sessionId}
  billingApiUrl="https://api.flopay.com"
  email={email}
  layout="buttons"
  cardBackButtonContent=""
  cardTitleContent="Enter card details"
/>

See FloPayCheckout — Layout Modes for theme presets and custom styling options.

Button Hooks

<SplitCardForm
  sessionId={sessionId}
  billingApiUrl="https://api.flopay.com"
  email={email}
  layout="buttons"
  onBeforeButtonClick={async ({ method }) => {
    if (method !== 'card') return;

    const confirmed = await confirmCardCheckoutDetails();
    if (!confirmed) return false;
  }}
  onButtonClick={(method) => {
    console.log('clicked:', method);
  }}
  onDecline={(decline) => {
    console.log('declined:', decline);
  }}
/>

onBeforeButtonClick only runs for the buttons-layout credit card button. Throwing routes the error through onError.

Example

<FloPayProvider
  flopay={flopayPromise}
  options={{ amount: 4999, currency: 'usd', paymentMethodCreation: 'manual' }}
>
  <SplitCardForm
    sessionId="uuid-xxx"
    billingApiUrl="https://api.example.com"
    email="user@example.com"
    userId="user_1"
    totalAmount={49.99}
    currency="usd"
    onComplete={(result) => router.push('/success')}
    onFirstNameChange={setFirstName}
    onLastNameChange={setLastName}
  />
</FloPayProvider>

SplitCardForm

SplitCardForm

Props

SplitCardFormRef

Default Layout

Buttons Layout

Button Hooks

Example

On this page