Primer Docs

Create a session and start Headless Universal Checkout with its clientToken and your custom settings. Once the session is configured on the SDK the completion handler will be called.

1234567func start(    withClientToken clientToken: String,    settings: PrimerSettings? = nil,    delegate: PrimerHeadlessUniversalCheckoutDelegate? = nil,    uiDelegate: PrimerHeadlessUniversalCheckoutUIDelegate? = nil,    completion: @escaping (_ paymentMethods: [PrimerHeadlessUniversalCheckout.PaymentMethod]?, _ err: Error?) -> Void)

swift

copy

Parameters

Client token as returned by the create client session call

properties

Use this to set you payment handling flow. Defaults to .auto.

cases

Primer SDK will create the payment and handle the flow.

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.

Forces some payment methods' locale.

properties

Forces the language code (e.g. en). Defaults on your app's language code if available.

Forces the language code (e.g. US). Defaults on your app's region code if available.

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.

⚠️ Required when using Apple Pay in your integration.

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.

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.

⚠️ Required when using Klarna in your integration.

properties

recurringPaymentDescription

StringRequired

Set the payment description that will be shown on the Klarna screen.

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.

Properties

Set the Stripe publishable key.

One of:

fullMandate(text:)

MandateData

The full text that you would like to be displayed to the user before they accept/decline the mandate.

A merchantName that will be used as part of our predefined mandate template.

Set the uiOptions for custom UI options of the Primer SDK.

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 a custom theme for Primer SDK.

properties

❗

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.

Indicates whether client session caching is enabled.

When set to 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.

Set the delegate to receive updates of the checkout lifecycle.

Set the UI delegate to receive UI updates.

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