@suluk/payments - v0.1.0
    Preparing search index...

    Interface AuthorizeRequest

    interface AuthorizeRequest {
        merchantTransactionId: string;
        amount: MinorAmount;
        captureMethod: CaptureMethod;
        paymentMethod: PaymentMethod;
        authType: AuthenticationType;
        address?: Address;
        returnUrl?: string;
        orderDetails?: OrderDetail[];
        customerId?: string;
        setupFutureUsage?: boolean;
        offSession?: boolean;
        metadata?: Record<string, string>;
        testMode?: boolean;
    }
    Index

    Properties

    merchantTransactionId amount captureMethod paymentMethod authType address? returnUrl? orderDetails? customerId? setupFutureUsage? offSession? metadata? testMode?

    Properties

    merchantTransactionId: string
    amount: MinorAmount
    captureMethod: CaptureMethod
    paymentMethod: PaymentMethod
    authType: AuthenticationType
    address?: Address
    returnUrl?: string
    orderDetails?: OrderDetail[]
    customerId?: string

    an existing processor customer to attach the charge to (optional).

    setupFutureUsage?: boolean

    save the instrument for later off-session use (recurring / one-click).

    offSession?: boolean

    the charge is happening WITHOUT the cardholder present (auto top-up / recurring) — the processor may decline for 3DS (AUTHENTICATION_PENDING) rather than charge. Maps to Stripe off_session, Adyen ContAuth, etc.

    metadata?: Record<string, string>

    free-form key/value the processor stores + echoes on its webhook (e.g. { userId, credits } the crediting path reads). Most processors support it (Stripe metadata, Adyen additionalData).

    testMode?: boolean

    Settings

    Member Visibility

    On This Page

    Properties