start - Primer

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

KOTLIN

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

Parameters

Hide Parameters

context

Context

required

Android Context of your Activity or Fragment.

clientToken

String

required

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

settings

PrimerSettings

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

Hide child attributes

paymentHandling

PrimerPaymentHandling

Default: PrimerPaymentHandling.AUTO

Force the payment handling in the SDK.

Show child attributes

AUTO

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

MANUAL

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

locale

Locale

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

paymentMethodOptions

PrimerPaymentMethodOptions

Show child attributes

redirectScheme

String?

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

threeDsOptions

PrimerThreeDsOptions

Sets the 3DS options in the SDK.

Hide Properties

threeDsAppRequestorUrl

String?

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.

googlePayOptions

PrimerGooglePayOptions

⚠️ Required when using Google Pay in your integration.

Hide Properties

merchantName

String?

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

allowedCardNetworks

List<String>

Default: listOf('AMEX', 'DISCOVER', 'JCB', 'MASTERCARD', 'VISA')

Sets the card networks that your application accepts.

buttonStyle

GooglePayButtonStyle

Default: GooglePayButtonStyle.BLACK

Sets the style of the Google Pay button.

Hide GooglePayButtonStyle

BLACK

Style of button to be used on light theme.

WHITE

Style of button to be used on dark theme.

captureBillingAddress

Boolean

Default: false

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

existingPaymentMethodRequired

Boolean

Default: false

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.

shippingAddressParameters

PrimerGoogleShippingAddressParameters

Default: null

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

Hide PrimerGoogleShippingAddressParameters

phoneNumberRequired

Boolean

Default: false

Sets whether the phone number should also be collected.

requireShippingMethod

Boolean

Default: false

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.

emailAddressRequired

Boolean

Default: false

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

buttonOptions

GooglePayButtonOptions

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

Hide Properties

buttonType

Int

Google Pay Button type as described in the official documentation.

buttonTheme

Int

Google Pay button style as described in the official documentation

klarnaOptions

PrimerKlarnaOptions

⚠️ Required when using Klarna in your integration.

Hide Properties

recurringPaymentDescription

String?

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

webViewTitle

String?

Default: Klarna

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

stripeOptions

PrimerStripeOptions

⚠️ Required when using Stripe ACH in your integration.

Hide Properties

publishableKey

String?

Set the Stripe publishable key.

mandateData

MandateData?

Data used for mandate in Drop-in

Show child attributes

TemplateMandateData

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

Hide Properties

merchantName

String

The name of the merchant.

FullMandateData

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

Hide Properties

value

@StringRes Int

The string resource pointing to the full mandate.

FullMandateStringData

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

Hide Properties

value

String

The full mandate.

uiOptions

PrimerUIOptions

Sets the different UI options in the SDK.

Hide Properties

isInitScreenEnabled

Boolean

Default: true

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

isSuccessScreenEnabled

Boolean

Default: true

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

isErrorScreenEnabled

Boolean

Default: true

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

dismissalMechanism

DismissalMechanism

Default: GESTURES

Set the mechanism for dismissing Universal Checkout. Options are:

GESTURES: The dialog can be dismissed by tapping outside or by swiping down.
CLOSE_BUTTON: A close button is provided, allowing users to dismiss the dialog manually.

theme

PrimerTheme

Set a custom theme for Primer SDK.

cardFormUIOptions

PrimerCardFormUIOptions?

Configure the card form UI options.

Hide Properties

payButtonAddNewCard

Boolean

When set to true, the Drop-In’s card form pay button will show “Add new card”; otherwise it will show “Pay $x.xx”.

debugOptions

PrimerDebugOptions

Sets the different debug options in the SDK.

Hide Properties

is3DSSanityCheckEnabled

Boolean

Default: false

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

clientSessionCachingEnabled

Boolean

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.

apiVersion

PrimerApiVersion

Default: PrimerApiVersion.V2_3

Indicates the API version to use when interacting with the Primer backend. Options are:

PrimerApiVersion.V2_3 - will use ApiVersion 2.3
PrimerApiVersion.V2_4 - will use ApiVersion 2.4
PrimerApiVersion.LATEST - will use the latest available ApiVersion version

Note that this is optional, if a value is not supplied, ApiVersion V2.4 will be used by default.

checkoutListener

PrimerHeadlessUniversalCheckoutListener

Set Primer SDK’s Headless Checkout Listener and implement the required methods.

uiListener

PrimerHeadlessUniversalCheckoutUiListener

Set Primer SDK’s Headless Checkout Ui Listener.

Android SDK

​Parameters

Parameters