@sumup/sdk
    Preparing search index...

    Type Alias ProcessCheckout

    Process Checkout

    Request body for attempting payment on an existing checkout. The required companion fields depend on the selected payment_type, for example card details, saved-card data, or payer information required by a specific payment method.

    type ProcessCheckout = {
        apple_pay?: Record<string, unknown>;
        card?: Card;
        customer_id?: string;
        google_pay?: Record<string, unknown>;
        installments?: number;
        mandate?: MandatePayload;
        payment_type:
            | "card"
            | "boleto"
            | "ideal"
            | "blik"
            | "bancontact"
            | "google_pay"
            | "apple_pay";
        personal_details?: PersonalDetails;
        token?: string;
    }
    Index

    Properties

    apple_pay? card? customer_id? google_pay? installments? mandate? payment_type personal_details? token?

    Properties

    apple_pay?: Record<string, unknown>

    Raw payment token object received from Apple Pay. Send the Apple Pay response payload as-is.

    card?: Card
    customer_id?: string

    Customer identifier associated with the saved payment instrument. Required when token is provided.

    google_pay?: Record<string, unknown>

    Raw PaymentData object received from Google Pay. Send the Google Pay response payload as-is.

    installments?: number

    Number of installments for deferred payments. Available only to merchant users in Brazil.

    mandate?: MandatePayload
    payment_type:
        | "card"
        | "boleto"
        | "ideal"
        | "blik"
        | "bancontact"
        | "google_pay"
        | "apple_pay"

    Payment method used for this processing attempt. It determines which additional request fields are required.

    personal_details?: PersonalDetails
    token?: string

    Saved-card token to use instead of raw card details when processing with a previously stored payment instrument.

    Settings

    Member Visibility

    On This Page

    Properties