@sumup/sdk
    Preparing search index...

    Class Checkouts

    API resource for the Checkouts endpoints.

    Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout captures the payment intent, such as the amount, currency, merchant, and optional customer or redirect settings, and then moves through its lifecycle as you process it.

    Use this tag to:

    • create a checkout before collecting or confirming payment details
    • process the checkout with a card, saved card, wallet, or supported alternative payment method
    • retrieve or list checkouts to inspect their current state and associated payment attempts
    • deactivate a checkout that should no longer be used

    Typical workflow:

    • create a checkout with the order amount, currency, and merchant information
    • process the checkout through SumUp client tools such as the Payment Widget and Swift Checkout SDK
    • retrieve the checkout or use the Transactions endpoints to inspect the resulting payment record

    Checkouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.

    Hierarchy

    • APIResource
      • Checkouts
    Index

    Constructors

    Properties

    _client: SumUp

    Methods