Configuring Universal Checkout is as easy as implementing one line of code.
Note that there are more settings which can be passed to Universal Checkout.
Please refer to the section below for more information.
Use this to set you payment handling flow. Defaults to .auto.
Hide Cases
default
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.
PrimerLocaleData
Forces some payment methods’ locale.
Hide Properties
String
required
Forces the language code (e.g. en). Defaults on your app’s language code if available.
String
Forces the language code (e.g. US). Defaults on your app’s region code if available.
PrimerPaymentMethodOptions
Hide Properties
String
⚠️ 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.
PrimerApplePayOptions
⚠️ Required when using Apple Pay in your integration.
Hide Properties
String
required
Set it to the merchant identifier as it is shown in your Apple Pay
certificate.
String
deprecated
Set it to the merchant name that you want to be shown on the Apple Pay screen. Deprecated, use ClientSession instead.
Bool
Defaults to false. Set to true to let Apple Pay capture the customer’s billing address.Use BillingOptions to configure required billing fields.
Bool
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.
Bool
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.
ShippingOptions
Configure shipping options for Apple Pay.
Hide Properties
Array of RequiredContactField
Specify which contact fields are required for shipping.
Bool
Indicate if a shipping method is required.
BillingOptions
Configure billing options for Apple Pay.
Hide Properties
Array of RequiredContactField
Specify which contact fields are required for billing.
Array of CardType
Restrict the card types Apple Pay offers. Supported values: .credit, .debit. When omitted or empty, all card types are offered.
PrimerKlarnaOptions
⚠️ Required when using Klarna in your integration.
Hide Properties
String
required
Set the payment description that will be shown on the Klarna screen.
PrimerThreeDsOptions
Hide Properties
String
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.
PrimerStripeOptions
⚠️ Required when using Stripe ACH in your integration.
The full text that you would like to be displayed to the user before
they accept/decline the mandate.
MandateData
A merchantName that will be used as part of our predefined mandate template.
PrimerUIOptions
Set the uiOptions for custom UI options of the Primer SDK.
Hide Properties
Bool
Set to false to hide the loading screen before the Universal Checkout or the Vault Manager. Defaults to true.
Bool
Set to false to hide the screen after a successful payment, or tokenization on the vault flow. Defaults to true.
Bool
Set to false to hide the error screen when an error occurs. Defaults to true.
enum DismissalMechanism
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.
PrimerTheme
Set a custom theme for Primer SDK.
enum PrimerAppearanceMode
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.
Hide Cases
default
Follow the system’s appearance setting (default behavior).
Force light mode appearance regardless of system setting.
Force dark mode appearance regardless of system setting.
PrimerCardFormUIOptions?
Configure the card form UI options.
Hide Properties
Bool
When set to true, the Drop-In’s card form pay button will show “Add new card”; otherwise it will show “Pay $x.xx”.
PrimerDebugOptions
Hide Properties
Bool
required
Bool
Default: false
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.
PrimerApiVersion
Default: PrimerApiVersion.V2_4
Indicates the API version to use when interacting with the Primer backend. Options are:
PrimerApiVersion.V2_4 - will use ApiVersion 2.4
Note that this is optional, if a value is not supplied, ApiVersion V2.4 will be used by default.
PrimerDelegate
Optional
Set Primer SDK’s delegate and implement the required delegate methods. Alternatively you can set the delegate directly like Primer.shared.delegate = yourDelegate.