@sumup/sdk
    Preparing search index...

    Type Alias CheckoutCreateRequest

    Details of the payment checkout.

    type CheckoutCreateRequest = {
        amount: number;
        checkout_reference: string;
        currency: SumUp.Checkouts.Currency;
        customer_id?: string;
        date?: string;
        description?: string;
        id?: string;
        merchant_code: string;
        pay_to_email?: string;
        purpose?: "CHECKOUT" | "SETUP_RECURRING_PAYMENT";
        redirect_url?: string;
        return_url?: string;
        status?: "PENDING" | "FAILED" | "PAID";
        transactions?: (
            SumUp.Checkouts.TransactionMixinBase & SumUp.Checkouts.TransactionMixinCheckout
        )[];
        valid_until?: string
        | null;
    }
    Index

    Properties

    amount checkout_reference currency customer_id? date? description? id? merchant_code pay_to_email? purpose? redirect_url? return_url? status? transactions? valid_until?

    Properties

    amount: number

    Amount of the payment.

    checkout_reference: string

    Unique ID of the payment checkout specified by the client application when creating the checkout resource.

    currency: SumUp.Checkouts.Currency
    customer_id?: string

    Unique identification of a customer. If specified, the checkout session and payment instrument are associated with the referenced customer.

    date?: string

    Date and time of the creation of the payment checkout. Response format expressed according to ISO8601 code.

    description?: string

    Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.

    id?: string

    Unique ID of the checkout resource.

    merchant_code: string

    Unique identifying code of the merchant profile.

    pay_to_email?: string

    Email address of the registered user (merchant) to whom the payment is made.

    @deprecated: pay_to_email is deprecated, use merchant_code instead.

    purpose?: "CHECKOUT" | "SETUP_RECURRING_PAYMENT"

    Purpose of the checkout.

    redirect_url?: string

    Required for APMs and recommended for card payments. Refers to a url where the end user is redirected once the payment processing completes. If not specified, the Payment Widget renders 3DS challenge within an iframe instead of performing a full-page redirect.

    return_url?: string

    URL to which the SumUp platform sends the processing status of the payment checkout.

    status?: "PENDING" | "FAILED" | "PAID"

    Current status of the checkout.

    transactions?: (
        SumUp.Checkouts.TransactionMixinBase & SumUp.Checkouts.TransactionMixinCheckout
    )[]

    List of transactions related to the payment.

    valid_until?: string | null

    Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time.

    Settings

    Member Visibility

    On This Page

    Properties