Amount to be charged to the payer, expressed in major units.
Merchant-defined reference for the new checkout. It should be unique enough for you to identify the payment attempt in your own systems.
Optionalcustomer_Merchant-scoped customer identifier. Required when setting up recurring payments and useful when the checkout should be linked to a returning payer.
OptionaldescriptionShort merchant-defined description shown in SumUp tools and reporting for easier identification of the checkout.
Merchant account that should receive the payment.
OptionalpurposeBusiness purpose of the checkout. Use CHECKOUT for a standard payment and SETUP_RECURRING_PAYMENT when collecting consent and payment details for future recurring charges.
Optionalredirect_URL where the payer should be sent after a redirect-based payment or SCA flow completes. This is required for APMs and recommended for card checkouts that may require 3DS. If it is omitted, the Payment Widget can render the challenge in an iframe instead of using a full-page redirect.
Optionalreturn_Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.
Optionalvalid_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.
Checkout Create Request
Request body for creating a checkout before processing payment. Define the payment amount, currency, merchant, and optional customer or redirect behavior here.