Protected_Creates a payment checkout for the specified merchant, amount, and currency. Supply a checkout_reference to identify the payment attempt in your own systems. Creating a checkout does not charge a payment instrument.
Set hosted_checkout.enabled to true to receive a Hosted Checkout URL where the customer can complete the payment.
Use redirect_url for redirect-based payment and 3DS flows. If return_url is provided, SumUp sends processing updates to that backend callback URL.
Complete the payment through Hosted Checkout or the Payment Widget.
Optionaloptions: RequestOptionsCreates an Apple Pay merchant session for the specified checkout.
Use this endpoint after the customer selects Apple Pay and before calling
ApplePaySession.completeMerchantValidation(...) in the browser.
SumUp validates the merchant session request and returns the Apple Pay
session object that your frontend should pass to Apple's JavaScript API.
Optionalbody: CreateApplePaySessionParamsOptionaloptions: RequestOptionsOptionalbody: CreateApplePaySessionParamsOptionaloptions: RequestOptionsOptionaloptions: RequestOptionsDeactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.
Optionaloptions: RequestOptionsOptionaloptions: RequestOptionsRetrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.
Optionaloptions: RequestOptionsOptionaloptions: RequestOptionsLists created checkout resources according to the applied checkout_reference.
Optionalquery: ListCheckoutsQueryParamsOptionaloptions: RequestOptionsGet payment methods available for the given merchant to use with a checkout.
Optionalquery: GetPaymentMethodsQueryParamsOptionaloptions: RequestOptionsOptionalquery: GetPaymentMethodsQueryParamsOptionaloptions: RequestOptionsOptionalquery: ListCheckoutsQueryParamsOptionaloptions: RequestOptions:::caution[PCI DSS compliance required] When you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable PCI DSS requirements. You should only use this integration if your environment is appropriately PCI DSS compliant. :::
Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint.
Follow this request with Retrieve a checkout to confirm its status.
Optionaloptions: RequestOptionsOptionaloptions: RequestOptionsUpdates the amount, currency, description, reference, expiration, or customer associated with an existing checkout. Only the supplied fields are updated.
This request changes the checkout details; it does not charge a payment instrument. Process the checkout separately to attempt a payment.
Optionaloptions: RequestOptionsOptionaloptions: RequestOptions
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:
Typical workflow:
Checkouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.