v50

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-0342108400.9 KB
Checkouts

Create an Apple Pay session

Creates 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.

put/v0.2/checkouts/{checkout_id}/apple-pay-session

Path parameters

checkout_idstring required

Unique ID of the checkout resource.

Request body

contextstring hostname required

the context to create this apple pay session.

targetstring uri required

The target url to create this apple pay session.

Example request

{
  "context": "example.com",
  "target": "https://apple-pay-gateway-cert.apple.com/paymentservices/startSession"
}

Response

Successful request. Returns the Apple Pay merchant session object that should be forwarded to the Apple Pay JS SDK to complete merchant validation and continue the payment flow.

object required