PayFanout API reference
    Preparing search index...

    Interface PayFanoutContextValue

    interface PayFanoutContextValue {
        activePsp: string | undefined;
        adapters: ReadonlyMap<string, ClientPaymentAdapter>;
        completionEndpoint: string | undefined;
        fieldsOwnerRef: RefObject<object | null>;
        lastError: UnifiedError | undefined;
        locale: string | undefined;
        mountedRef: RefObject<MountedEntry | null>;
        setActivePsp: (psp: string) => void;
        setLastError: (err: UnifiedError | undefined) => void;
        setStatus: (status: PayFanoutStatus) => void;
        status: PayFanoutStatus;
    }
    Index
    activePsp adapters completionEndpoint fieldsOwnerRef lastError locale mountedRef setActivePsp setLastError setStatus status
    activePsp: string | undefined
    adapters: ReadonlyMap<string, ClientPaymentAdapter>
    completionEndpoint: string | undefined

    Host route that finalizes tokenize-first payments; undefined disables auto-completion.

    fieldsOwnerRef: RefObject<object | null>

    Identity of the instance holding the single mount slot. Claimed synchronously when its mount effect starts (before the async SDK load), so a second concurrent instance is rejected instead of silently stealing the slot.

    lastError: UnifiedError | undefined
    locale: string | undefined

    BCP-47 locale for library-rendered text; undefined means English.

    mountedRef: RefObject<MountedEntry | null>

    The currently mounted fields — what PayButton confirms.

    setActivePsp: (psp: string) => void
    setLastError: (err: UnifiedError | undefined) => void
    setStatus: (status: PayFanoutStatus) => void
    status: PayFanoutStatus

    Settings
    Member Visibility

    On This Page
    Properties