Sarraf API
    Preparing search index...

    Interface PaymobProviderOptions

    interface PaymobProviderOptions {
        addCardToSubscription?: number;
        billingData?: Record<string, string>;
        capture?: "manual";
        cardTokens?: string[];
        extras?: Record<string, unknown>;
        paymentMethods?: (string | number)[];
        subscription?: { planId: number; startDate?: string };
    }
    Index
    addCardToSubscription? billingData? capture? cardTokens? extras? paymentMethods? subscription?
    addCardToSubscription?: number

    Add the card used on this checkout to an existing subscription, as a secondary card.

    billingData?: Record<string, string>

    Extra billing_data fields (street, city, country, …).

    capture?: "manual"

    "manual" authorizes the card only (needs integrationIds.card_auth); capture it later with pay.payments.capture(...). Uncaptured authorizations are voided by Paymob after 14 days.

    cardTokens?: string[]

    Saved card tokens (from card.saved events) offered on the checkout, max 3.

    extras?: Record<string, unknown>

    Merged into the intention's extras.

    paymentMethods?: (string | number)[]

    Raw integration ids or method names, overriding methods.

    subscription?: { planId: number; startDate?: string }

    Start a subscription on this plan with the first (3DS) payment.

    Settings
    Member Visibility

    On This Page
    Properties