PayFanout API reference
    Preparing search index...

    Interface PayFanoutProviderProps

    interface PayFanoutProviderProps {
        adapters: ClientPaymentAdapter[];
        children: ReactNode;
        completionEndpoint?: string;
        initialPsp?: string;
        locale?: string;
    }
    Index
    adapters children completionEndpoint? initialPsp? locale?
    adapters: ClientPaymentAdapter[]

    Client adapters only — no secrets, no server logic.

    children: ReactNode
    completionEndpoint?: string

    Host route that finalizes tokenize-first payments (Paysafe, PayPal). When set, usePay/<PayButton> derive onServerCompletion automatically — they POST { sessionRef, clientToken, billingDetails? } here (mount @payfanout/server's createCompletionHandler at this path) and no per-surface completion wiring is needed. An explicit onServerCompletion still wins, as the escape hatch for a custom transport.

    initialPsp?: string

    Defaults to the first adapter.

    locale?: string

    BCP-47 locale for the text the library renders itself — currently the default <PayButton> label. PayFanout ships en/fr/de/es; unknown locales fall back to English. Does not touch the PSP's hosted field texts (set those via <PaymentFields locale>).

    Settings
    Member Visibility

    On This Page
    Properties