@sumup/sdk
    Preparing search index...

    Type Alias Checkout

    Checkout

    Core checkout resource returned by the Checkouts API. A checkout is created before payment processing and then updated as payment attempts, redirects, and resulting transactions are attached to it.

    type Checkout = {
        amount?: number;
        checkout_reference?: string;
        currency?: Currency;
        customer_id?: string;
        date?: string;
        description?: string;
        id?: string;
        mandate?: MandateResponse;
        merchant_code?: string;
        return_url?: string;
        status?: "PENDING" | "FAILED" | "PAID" | "EXPIRED";
        transactions?: (TransactionBase & TransactionCheckoutInfo)[];
        valid_until?: string | null;
    }
    Index

    Properties

    amount? checkout_reference? currency? customer_id? date? description? id? mandate? merchant_code? return_url? status? transactions? valid_until?

    Properties

    amount?: number

    Amount to be charged to the payer, expressed in major units.

    checkout_reference?: string

    Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart, subscription, or payment attempt in your systems.

    currency?: Currency
    customer_id?: string

    Merchant-scoped identifier of the customer associated with the checkout. Use it when storing payment instruments or reusing saved customer context for recurring and returning-payer flows.

    date?: string

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

    description?: string

    Short merchant-defined description shown in SumUp tools and reporting. Use it to make the checkout easier to recognize in dashboards, support workflows, and reconciliation.

    id?: string

    Unique SumUp identifier of the checkout resource.

    mandate?: MandateResponse
    merchant_code?: string

    Merchant account that receives the payment.

    return_url?: string

    Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.

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

    Current high-level state of the checkout. PENDING means the checkout exists but is not yet completed, PAID means a payment succeeded, FAILED means the latest processing attempt failed, and EXPIRED means the checkout can no longer be processed.

    transactions?: (TransactionBase & TransactionCheckoutInfo)[]

    Payment attempts and resulting transaction records linked to this checkout. Use the Transactions endpoints when you need the authoritative payment result and event history.

    valid_until?: string | null

    Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable. If omitted, the checkout does not have an explicit expiry time.

    Settings

    Member Visibility

    On This Page

    Properties