Primer Docs

Create a session and start Headless Universal Checkout with its clientToken and your custom settings.

1234567fun start(    context: Context,    clientToken: String,    settings: PrimerSettings? = null,    checkoutListener: PrimerHeadlessUniversalCheckoutListener? = null,    uiListener: PrimerHeadlessUniversalCheckoutUiListener? = null)

kotlin

copy

Parameters

context

ContextRequired

Android Context of your Activity or Fragment.

A client token as returned by the create client session call.

⚠️ If no settings are provided, the SDK will initialize with its default settings.
Use PrimerSettings to provide different options based on your use case.

Force the payment handling in the SDK.

By default, the SDK operates in PrimerPaymentHandling.AUTO mode. In this case the SDK is responsible for creating the payment.

You can use the PrimerPaymentHandling.MANUAL option in order to handle the payment creation by yourself.

Force the SDK locale. By default, the locale will be set to the device's locale.

Sets the deeplink schema used when redirecting back from 3rd party applications to your application.

Sets the 3DS options in the SDK.

Properties

Set the App 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 Google Pay in your integration.

Properties

Set it the merchant name that you want to be shown on the Google Pay screen.

Sets the card networks that your application accepts.

Sets the style of the Google Pay button.

GooglePayButtonStyle

Style of button to be used on light theme.

Style of button to be used on dark theme.

Sets whether user's billing address should be captured from Google Pay.

If set to true, this specifies that Google Pay can only be used for payments if the user's Google Pay wallet already contains allowed payment methods.

Indicates whether the shipping address should be collected during the checkout process. Note that setting at least one shipping method in Checkout. Shipping module is necessary

PrimerGoogleShippingAddressParameters

Sets whether the phone number should also be collected.

Indicates whether selecting a shipping method is required during the checkout process. At least one shipping option should be configured in order to use this option.

This should be set to true if the shippingAddressParameters are also used.

Indicates whether the email address should be collected during the checkout process.

A configuration class for customizing the appearance of the Google Pay button.

Google Pay Button type as described in the official documentation.

Google Pay button style as described in the official documentation

⚠️ Required when using Klarna in your integration.

Properties

recurringPaymentDescription

String?

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

⚠️ This option is Deprecated. Sets the toolbar title of the Activity displaying Klarna views.

⚠️ Required when using Stripe ACH in your integration.

Properties

Set the Stripe publishable key.

Data used for mandate in Drop-in

Data for the mandate allowing you to specify the name of the merchant that would be used in a predefined mandate template.

Properties

The name of the merchant.

Data for the mandate allowing you to specify the string resource pointing to the full mandate.

Properties

The string resource pointing to the full mandate.

Data for the mandate allowing you to specify the full mandate as a string.

Properties

The full mandate.

Sets the different UI options in the SDK.

Properties

Set to false to hide the loading screen before the Universal Checkout or the Vault Manager.

Set to false to hide the screen after a successful payment, or tokenization on the vault flow.

Set to false to hide the error screen when an error occurs.

Set a custom theme for Primer SDK.

Sets the different debug options in the SDK.

Properties

Sets whether the security warnings returned when performing 3DS are ignored.

❗

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 Primer SDK's Headless Checkout Listener and implement the required methods.

Set Primer SDK's Headless Checkout Ui Listener.