Create a session and start Headless Universal Checkout with itsDocumentation Index
Fetch the complete documentation index at: https://primer.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
clientToken and your custom settings.
Once the session is configured on the SDK the completion handler will be called.
SWIFT
func start(
withClientToken clientToken: String,
settings: PrimerSettings? = nil,
delegate: PrimerHeadlessUniversalCheckoutDelegate? = nil,
uiDelegate: PrimerHeadlessUniversalCheckoutUIDelegate? = nil,
completion: @escaping (_ paymentMethods: [PrimerHeadlessUniversalCheckout.PaymentMethod]?, _ err: Error?) -> Void
)
Parameters
Hide Parameters
Hide Parameters
Client token as returned by the create client session call
Hide Properties
Hide Properties
Use this to set you payment handling flow. Defaults to
.auto.Hide Cases
Hide Cases
Primer SDK will create the payment and handle the flow.
manual
If you use the manual flow, make sure you add the
primerDidTokenizePaymentMethod(_:decisionHandler:) delegate function of PrimerDelegate, create a payment on your backend and call the decisionHandler of the delegate function once you receive your backend’s response.Hide Properties
Hide Properties
⚠️ Required for some payment methods (e.g. PayPal).
This option sets the deeplink schema used when redirecting back from 3rd party applications to your app.
This option sets the deeplink schema used when redirecting back from 3rd party applications to your app.
⚠️ Required when using Apple Pay in your integration.
Hide Properties
Hide Properties
Set it to the merchant identifier as it is shown in your Apple Pay
certificate.
Set it to the merchant name that you want to be shown on the Apple Pay screen. Deprecated, use ClientSession instead.
Defaults to
false. Set to true to let Apple Pay capture the customer’s billing address.Use BillingOptions to configure required billing fields.If in some cases you don’t want to present ApplePay option if the device is not supporting it set this to
false. The default value is true.Default value is true. Set to false if you do not want to present
Apple Pay option on unsupported devices.Flag introduced to enable the initiation of the ApplePay flow even when no cards are present in the Wallet. To enable the feature, set this to
false. The default value true.Default value is true. This flag supports the old behavior where Apple
Pay flow might not present if there are no cards in the Wallet.⚠️ Required when using Klarna in your integration.
Hide Properties
Hide Properties
Set the payment description that will be shown on the Klarna screen.
Hide Properties
Hide Properties
Set the iOS Universal Link that’s used to call your app after an out-of-band (OOB) authentication.
Supported in 3D Secure protocol versions 2.2.0 and after.
⚠️ Required when using Stripe ACH in your integration.
Hide Properties
Hide Properties
Set the Stripe publishable key.
Set the
uiOptions for custom UI options of the Primer SDK.Hide Properties
Hide Properties
Set to
false to hide the loading screen before the Universal Checkout or the Vault Manager. Defaults to true.Set to
false to hide the screen after a successful payment, or tokenization on the vault flow. Defaults to true.Set to
false to hide the error screen when an error occurs. Defaults to true.Set the mechanism for dismissing Universal Checkout. Options are:
gestures: The dialog can be dismissed by tapping outside or by swiping down.closeButton: A close button is provided, allowing users to dismiss the dialog manually.
Set a custom theme for Primer SDK.
Control the SDK’s appearance mode independently of the system setting. This allows apps to force light or dark mode regardless of the device’s appearance setting.
Before enabling the flag to true it’s recommended to reach out to Primer
support for additional verification since there are edge cases where it’s not
advised.
true, responses from the server will be cached on the client side, allowing for faster subsequent
access to the same data within the cache duration. When set to false, every request to the server will be
processed without utilizing any client-side cache, ensuring that the client always receives the most up-to-date data.Indicates the API version to use when interacting with the Primer backend. Options are:
PrimerApiVersion.V2_4- will use ApiVersion 2.4
V2.4 will be used by default.Set the delegate to receive updates of the checkout lifecycle.
Set the UI delegate to receive UI updates.
completion
(_ paymentMethods: [PrimerHeadlessUniversalCheckout.PaymentMethod]?, _ err: Error?) -> Void
Optional
The completion handler will be called once the session has been configured on the SDK, and it will provide you with available payment methods for the session