Class CheckoutSettings
-
- All Implemented Interfaces:
-
android.os.Parcelable
public class CheckoutSettings implements Parcelable
Represents the checkout settings, providing access to the checkout id, payment headerTitle, payment brands and more.
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description CheckoutSettings(String checkoutId, Set<String> paymentBrands, Connect.ProviderMode providerMode)Constructs a new checkout settings with the checkout id and payment brands.
-
Method Summary
Modifier and Type Method Description StringgetCheckoutId()Returns the checkout id. voidsetCheckoutId(@NonNull() String checkoutId)Sets the checkout id. StringgetLocale()Return a locale string value com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, or null if no locale has been assigned. CheckoutSettingssetLocale(@Nullable() String locale)Sets a specific locale for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity. StringgetKlarnaCountry()Returns the country for Klarna payment method. CheckoutSettingssetKlarnaCountry(@Nullable() String klarnaCountry)Sets the country for Klarna payment method. StringgetAciInstantPayCountry()Returns the country for ACI Instant Pay payment method. CheckoutSettingssetAciInstantPayCountry(@NonNull() String aciInstantPayCountry)Sets the country for ACI Instant Pay payment method. StringgetGooglePayPaymentDataRequestJson()Returns the PaymentDataRequest in JSON format. CheckoutSettingssetGooglePayPaymentDataRequestJson(@Nullable() String googlePayPaymentDataRequestJson)Sets the PaymentDataRequest in JSON format. StringgetPaymentButtonBrand()Returns the brand for payment button. CheckoutSettingssetPaymentButtonBrand(@Nullable() String paymentButtonBrand)Sets the brand for payment button. StringgetIdealBankAccountCountry()Returns the country code of iDEAL bank account. CheckoutSettingssetIdealBankAccountCountry(@Nullable() String idealBankAccountCountry)Sets the country code of iDEAL bank account. Connect.ProviderModegetProviderMode()Returns the Connect.ProviderMode. CheckoutSettingssetProviderMode(@NonNull() Connect.ProviderMode providerMode)Sets the Connect.ProviderMode. Set<String>getPaymentBrands()Returns the supported payment brands. CheckoutSettingssetPaymentBrands(@Nullable() Set<String> paymentBrands)Sets the supported payment methods. CheckoutStorePaymentDetailsModegetStorePaymentDetailsMode()Returns the mode for storing payment details of the upcoming transaction. CheckoutSettingssetStorePaymentDetailsMode(@NonNull() CheckoutStorePaymentDetailsMode storePaymentDetailsMode)Sets the mode for storing payment details of the upcoming transaction. CheckoutSkipCVVModegetSkipCVVMode()Returns the CheckoutSkipCVVMode for showing CVV. CheckoutSettingssetSkipCVVMode(@NonNull() CheckoutSkipCVVMode skipCVVMode)Sets the CheckoutSkipCVVMode for showing CVV. CheckoutCardBrandsDisplayModegetCardBrandsDisplayMode()Returns the mode for showing card brands on the payment method selection screen CheckoutCardBrandsDisplayMode. CheckoutSettingssetCardBrandsDisplayMode(@NonNull() CheckoutCardBrandsDisplayMode cardBrandsDisplayMode)Sets the mode for showing card brands on the payment method selection screen CheckoutCardBrandsDisplayMode. CheckoutSecurityPolicyModegetSecurityPolicyModeForTokens()Returns security policy mode for tokens. CheckoutSettingssetSecurityPolicyModeForTokens(@Nullable() CheckoutSecurityPolicyMode securityPolicyModeForTokens)Sets security policy mode for tokens. IPaymentFormListenergetPaymentFormListener()Returns listener object which will receive payment form events. CheckoutSettingssetPaymentFormListener(@Nullable() IPaymentFormListener paymentFormListener)Sets listener object which will receive payment form events. OnBeforeSubmitCallbackgetOnBeforeSubmitCallback()Returns callback which will receive PaymentDetails. CheckoutSettingssetOnBeforeSubmitCallback(@Nullable() OnBeforeSubmitCallback onBeforeSubmitCallback)Sets callback which will receive PaymentDetails. Array<Integer>getInstallmentOptions()Returns an array of possible numbers of installments. CheckoutSettingssetInstallmentOptions(@NonNull() Array<Integer> installmentOptions)Sets list of possible numbers of installments. CheckoutBrandDetectionTypegetBrandDetectionType()Returns the type of automatic card brand detection to be used. CheckoutSettingssetBrandDetectionType(@NonNull() CheckoutBrandDetectionType brandDetectionType)Sets the type of automatic card brand detection CheckoutBrandDetectionType Default value is REGEX. CheckoutBrandDetectionAppearanceStylegetBrandDetectionAppearanceStyle()Returns the brand detection appearance style. CheckoutSettingssetBrandDetectionAppearanceStyle(@NonNull() CheckoutBrandDetectionAppearanceStyle brandDetectionAppearanceStyle)Sets the brand detection appearance style CheckoutBrandDetectionAppearanceStyle Default value is ACTIVE. List<String>getBrandDetectionPriority()Returns the preferred order of the detected card brands to be shown under the card number text field. CheckoutSettingssetBrandDetectionPriority(@Nullable() List<String> brandDetectionPriority)Sets the preferred order of the detected card brands to be shown under the card number text field. SamsungPayConfiggetSamsungPayConfig()Returns the SamsungPay configuration. CheckoutSettingssetSamsungPayConfig(@Nullable() SamsungPayConfig samsungPayConfig)Sets the SamsungPay configuration. Map<String, Integer>getCustomLogos()Returns custom logos to be applied at the checkout. BillingAddressgetBillingAddress()Returns the billing address which holds the address of the customer. CheckoutSettingssetBillingAddress(@Nullable() BillingAddress billingAddress)Sets the billing address which holds the address of the customer. ComponentNamegetComponentName()Returns the component name to handle intents from CheckoutActivity. CheckoutSettingssetComponentName(@Nullable() ComponentName componentName)Sets the component name to handle intents from CheckoutActivity. ThreeDSConfiggetThreeDS2Config()Returns the configuration object to be used during service initialization. CheckoutSettingssetThreeDS2Config(@Nullable() ThreeDSConfig threeDS2Config)Sets configuration information that shall be used during initialization. Map<String, WpwlOptions>getWpwlOptions()Get payment brand and its WPWL configuration for checkout. CheckoutSettingssetWpwlOptions(@Nullable() Map<String, WpwlOptions> wpwlOptions)Set WPWL configuration information for specified brand. UiComponentsConfiggetUiComponentsConfig()Returns the UI Components configuration. CheckoutSettingssetUiComponentsConfig(@Nullable() UiComponentsConfig uiComponentsConfig)Sets the UI Components configuration. MbWayConfiggetMbWayConfig()Returns the configuration for MBWAY payment method. CheckoutSettingssetMbWayConfig(@Nullable() MbWayConfig mbWayConfig)Sets the configuration for MBWAY payment method. EnumSet<GooglePaySubmitType>getGooglePaySubmit()Get GooglePaySubmitType details submitted with payment request if information available in Google Pay payment response. CheckoutSettingssetGooglePaySubmit(@NonNull() EnumSet<GooglePaySubmitType> googlePaySubmit)Sets values GooglePaySubmitType details submitted with payment request if information available in Google Pay payment response. AfterpayPacificConfiggetAfterpayPacificConfig()Returns the configuration for AFTERPAY_PACIFIC payment method if it is set. CheckoutSettingssetAfterpayPacificConfig(@Nullable() AfterpayPacificConfig afterpayPacificConfig)Sets the configuration for AFTERPAY_PACIFIC payment method. CheckoutPaymentBrandConfiggetBrandConfig()Returns the configuration for brands, if it is set. CheckoutSettingssetBrandConfig(@Nullable() CheckoutPaymentBrandConfig config)Sets the configuration for all the payment brands. List<PayToPayIdType>getPayToPayIdTypes()Returns the order of PayTo brand's PayId Type. CheckoutSettingssetPayToPayIdTypes(@Nullable() List<PayToPayIdType> payToPayIdTypes)Sets the PayTo brand's PayId Type. intgetThemeResId()Return the theme resource id for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, or 0 if no resource id has been assigned. CheckoutSettingssetThemeResId(int themeResId)Sets a theme resource id for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, you can also set theme in your AndroidManifest.xml.doublegetKlarnaInvoiceFee()Returns the fee for Klarna Invoice payment method. CheckoutSettingssetKlarnaInvoiceFee(double klarnaInvoiceFee)Sets the fee for Klarna Invoice payment method. doublegetKlarnaInstallmentsFee()Returns the fee for Klarna Installments payment method. CheckoutSettingssetKlarnaInstallmentsFee(double klarnaInstallmentsFee)Sets the fee for Klarna Installments payment method. booleanisBackButtonAvailable()Returns falseif back button must be disabled for the payment button's payment brand,trueotherwise.CheckoutSettingssetBackButtonAvailable(boolean backButtonAvailable)Sets falseto disable back button for payment button's payment brand, otherwisetrue.booleanisWindowSecurityEnabled()If truetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displaysfalseotherwise.CheckoutSettingssetWindowSecurityEnabled(boolean windowSecurityEnabled)If truetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displaysfalseotherwise.booleanisSTCPayQrCodeRequired()If trueSTC pay payment method will show QR code optionfalseotherwise.CheckoutSettingssetSTCPayQrCodeRequired(boolean stcPayQrCodeRequired)If trueSTC pay payment method will show QR code optionfalseotherwise.booleanisShowOtpEnabled()Returns the boolean indicates if trueBlik OTP will be displayed on Blik payment UI.CheckoutSettingssetShowOtpEnabled(boolean showOtpEnabled)Sets the boolean indicates if truedisplay Blik OTP will be displayed on Blik payment UI.booleanisCardScanningEnabled()Indicates if card scanning feature (NFC/Camera) is enabled. CheckoutSettingssetCardScanningEnabled(boolean cardScanningEnabled)Enables or disables the card scanning feature. booleanisCardHolderVisible()If trueholder name field is visible on the card payment formfalseotherwise.CheckoutSettingssetCardHolderVisible(boolean cardHolderVisible)Set trueto show holder name field on the card payment formfalseto hide the field.booleanisInstallmentEnabled()Returns trueif payments by installments are enabled, otherwisefalse.CheckoutSettingssetInstallmentEnabled(boolean installmentEnabled)Set trueto display dropdown with getInstallmentOptions in the card payment form.booleanisTotalAmountRequired()Returns trueif total amount should be displayed in the checkout form;falseotherwise.CheckoutSettingssetTotalAmountRequired(boolean totalAmountRequired)If truetotal amount will be shown on the payment method selection screen and in the 'Pay' buttons,falseotherwise.booleanisIBANRequired()If trueGiropay payment method will show IBAN fieldfalseotherwise.CheckoutSettingssetIBANRequired(boolean ibanRequired)If trueGiropay payment method will show IBAN fieldfalseotherwise.booleanisPaymentBrandsOrderUsedForTokens()Indicates if payment brands order is used for tokens on payment method selection screen. CheckoutSettingssetPaymentBrandsOrderUsedForTokens(boolean isPaymentBrandsOrderUsedForTokens)Set if payment brands order should be used for tokens on payment method selection screen. booleanisShowBirthDate()If trueRatepay payment method will show Date of birth input filedfalseotherwise.CheckoutSettingssetShowBirthDate(boolean showBirthDate)If trueRatepay payment method will show Date of birth input filedfalseotherwise.booleanisCardExpiryDateValidationDisabled()Indicates if card expiry date validation is disabled. CheckoutSettingssetCardExpiryDateValidationDisabled(boolean cardExpiryDateValidationDisabled)Set card expiry date validation, if truecard expiry validation will be disabled,falseotherwise.booleangetDisablePayNowButtonOnError()Indicates if pay now button validation is enabled. CheckoutSettingssetDisablePayNowButtonOnError(boolean disablePayNowButtonOnError)Set trueto enable pay now button validation,falseto disable it.CheckoutSecurityPolicyModegetSecurityPolicyModeForBrand(@NonNull() String paymentBrand)Returns security policy mode for specific payment brand. CheckoutSettingssetSecurityPolicyModeForBrand(@NonNull() String paymentBrand, @NonNull() CheckoutSecurityPolicyMode securityPolicyMode)Sets security policy mode for specific payment brand. CheckoutSettingssetCustomLogo(@NonNull() String paymentBrand, int resourceId)Sets custom logo to be presented at the checkout for the specified payment brand. intdescribeContents()The part of Parcelable implementation. voidwriteToParcel(Parcel dest, int flags)The part of Parcelable implementation. StringtoString()booleanequals(@Nullable() Object o)inthashCode()-
-
Constructor Detail
-
CheckoutSettings
CheckoutSettings(String checkoutId, Set<String> paymentBrands, Connect.ProviderMode providerMode)
Constructs a new checkout settings with the checkout id and payment brands.- Parameters:
checkoutId- The checkout id.paymentBrands- The payment brands.providerMode- The Connect.ProviderMode.
-
-
Method Detail
-
getCheckoutId
@NonNull() String getCheckoutId()
Returns the checkout id.
- Returns:
The checkout id.
-
setCheckoutId
void setCheckoutId(@NonNull() String checkoutId)
Sets the checkout id.
- Parameters:
checkoutId- The checkout id.
-
getLocale
@Nullable() String getLocale()
Return a locale string value com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, or null if no locale has been assigned.
- Returns:
The locale string value, or null if not assigned.
-
setLocale
@NonNull() CheckoutSettings setLocale(@Nullable() String locale)
Sets a specific locale for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity.
- Parameters:
locale- The locale string value.- Returns:
A reference to this object.
-
getKlarnaCountry
@Nullable() String getKlarnaCountry()
Returns the country for Klarna payment method.
- Returns:
The country for Klarna payment method.
-
setKlarnaCountry
@NonNull() CheckoutSettings setKlarnaCountry(@Nullable() String klarnaCountry)
Sets the country for Klarna payment method. It should be one of these values DE, AT, NL, SE, NO, FI or DK. By default the country will be taken from the current locale, use this method to set the specific country for Klarna.
- Returns:
A reference to this object.
-
getAciInstantPayCountry
@NonNull() String getAciInstantPayCountry()
Returns the country for ACI Instant Pay payment method.
- Returns:
The country for ACI Instant Pay payment method.
-
setAciInstantPayCountry
@NonNull() CheckoutSettings setAciInstantPayCountry(@NonNull() String aciInstantPayCountry)
Sets the country for ACI Instant Pay payment method. It should be one of these values NL, DE, FR, BE, LV, EE, LT, ES, AT, IT, PT, GB, US. use this method to set the specific country for ACI Instant Pay.
- Returns:
A reference to this object.
-
getGooglePayPaymentDataRequestJson
@Nullable() String getGooglePayPaymentDataRequestJson()
Returns the PaymentDataRequest in JSON format.
- Returns:
The PaymentDataRequest in JSON format.
-
setGooglePayPaymentDataRequestJson
@NonNull() CheckoutSettings setGooglePayPaymentDataRequestJson(@Nullable() String googlePayPaymentDataRequestJson)
Sets the PaymentDataRequest in JSON format. The PaymentDataRequestJsonBuilder should be used to build it.
- Parameters:
googlePayPaymentDataRequestJson- The PaymentDataRequest in JSON format.- Returns:
A reference to this object.
-
getPaymentButtonBrand
@Nullable() String getPaymentButtonBrand()
Returns the brand for payment button.
- Returns:
The payment brand.
-
setPaymentButtonBrand
@NonNull() CheckoutSettings setPaymentButtonBrand(@Nullable() String paymentButtonBrand)
Sets the brand for payment button. This method is used internally for drop-in button integration.
- Parameters:
paymentButtonBrand- The payment brand.- Returns:
A reference to this object.
-
getIdealBankAccountCountry
@Nullable() String getIdealBankAccountCountry()
Returns the country code of iDEAL bank account.
- Returns:
The bank account country code if it is set, otherwise
null.
-
setIdealBankAccountCountry
@NonNull() CheckoutSettings setIdealBankAccountCountry(@Nullable() String idealBankAccountCountry)
Sets the country code of iDEAL bank account. NOTE: If it is set, the iDEAL 2.0 will be used.
- Parameters:
idealBankAccountCountry- The bank account country code in the following format [a-zA-Z]{2} (ISO 3166-1).- Returns:
A reference of this object.
-
getProviderMode
@NonNull() Connect.ProviderMode getProviderMode()
Returns the Connect.ProviderMode.
- Returns:
The Connect.ProviderMode.
-
setProviderMode
@NonNull() CheckoutSettings setProviderMode(@NonNull() Connect.ProviderMode providerMode)
Sets the Connect.ProviderMode.
- Parameters:
providerMode- The Connect.ProviderMode.- Returns:
A reference to this object.
-
getPaymentBrands
@Nullable() Set<String> getPaymentBrands()
Returns the supported payment brands.
- Returns:
The payment brands.
-
setPaymentBrands
@NonNull() CheckoutSettings setPaymentBrands(@Nullable() Set<String> paymentBrands)
Sets the supported payment methods. The order in the array corresponds to the position in the list.
- Parameters:
paymentBrands- The array of supported payment brands.- Returns:
A reference to this object.
-
getStorePaymentDetailsMode
@NonNull() CheckoutStorePaymentDetailsMode getStorePaymentDetailsMode()
Returns the mode for storing payment details of the upcoming transaction.
- Returns:
The transaction mode for storing payment details.
-
setStorePaymentDetailsMode
@NonNull() CheckoutSettings setStorePaymentDetailsMode(@NonNull() CheckoutStorePaymentDetailsMode storePaymentDetailsMode)
Sets the mode for storing payment details of the upcoming transaction. CheckoutStorePaymentDetailsMode Default value is NEVER.
- Parameters:
storePaymentDetailsMode- The CheckoutStorePaymentDetailsMode.- Returns:
A reference to this object.
-
getSkipCVVMode
@NonNull() CheckoutSkipCVVMode getSkipCVVMode()
Returns the CheckoutSkipCVVMode for showing CVV.
- Returns:
The CheckoutSkipCVVMode.
-
setSkipCVVMode
@NonNull() CheckoutSettings setSkipCVVMode(@NonNull() CheckoutSkipCVVMode skipCVVMode)
Sets the CheckoutSkipCVVMode for showing CVV. Default value is NEVER.
- Parameters:
skipCVVMode- The CVV mode.- Returns:
A reference to this object.
-
getCardBrandsDisplayMode
@NonNull() CheckoutCardBrandsDisplayMode getCardBrandsDisplayMode()
Returns the mode for showing card brands on the payment method selection screen CheckoutCardBrandsDisplayMode.
- Returns:
-
setCardBrandsDisplayMode
@NonNull() CheckoutSettings setCardBrandsDisplayMode(@NonNull() CheckoutCardBrandsDisplayMode cardBrandsDisplayMode)
Sets the mode for showing card brands on the payment method selection screen CheckoutCardBrandsDisplayMode. Default value is GROUPED.
- Parameters:
cardBrandsDisplayMode- The mode for displaying cards.- Returns:
A reference to this object.
-
getSecurityPolicyModeForTokens
@Nullable() CheckoutSecurityPolicyMode getSecurityPolicyModeForTokens()
Returns security policy mode for tokens.
- Returns:
-
setSecurityPolicyModeForTokens
@NonNull() CheckoutSettings setSecurityPolicyModeForTokens(@Nullable() CheckoutSecurityPolicyMode securityPolicyModeForTokens)
Sets security policy mode for tokens.
- Parameters:
securityPolicyModeForTokens- The CheckoutSecurityPolicyMode.- Returns:
A reference to this object.
-
getPaymentFormListener
@Nullable() IPaymentFormListener getPaymentFormListener()
Returns listener object which will receive payment form events.
- Returns:
The payment form listener.
-
setPaymentFormListener
@NonNull() CheckoutSettings setPaymentFormListener(@Nullable() IPaymentFormListener paymentFormListener)
Sets listener object which will receive payment form events.
- Parameters:
paymentFormListener- The listener object, should be parcelable.- Returns:
A reference to this object.
-
getOnBeforeSubmitCallback
@Nullable() OnBeforeSubmitCallback getOnBeforeSubmitCallback()
Returns callback which will receive PaymentDetails.
- Returns:
The before submit callback.
-
setOnBeforeSubmitCallback
@NonNull() CheckoutSettings setOnBeforeSubmitCallback(@Nullable() OnBeforeSubmitCallback onBeforeSubmitCallback)
Sets callback which will receive PaymentDetails. Only this callback will be used if component name for broadcast receiver was set in setComponentName.
- Parameters:
onBeforeSubmitCallback- Before submit callback, should be parcelable.- Returns:
A reference to this object.
-
getInstallmentOptions
@NonNull() Array<Integer> getInstallmentOptions()
Returns an array of possible numbers of installments.
- Returns:
An array of possible numbers of installments.
-
setInstallmentOptions
@NonNull() CheckoutSettings setInstallmentOptions(@NonNull() Array<Integer> installmentOptions)
Sets list of possible numbers of installments.
- Parameters:
installmentOptions- The list of possible numbers of installments.- Returns:
A reference to this object.
-
getBrandDetectionType
@NonNull() CheckoutBrandDetectionType getBrandDetectionType()
Returns the type of automatic card brand detection to be used.
- Returns:
-
setBrandDetectionType
@NonNull() CheckoutSettings setBrandDetectionType(@NonNull() CheckoutBrandDetectionType brandDetectionType)
Sets the type of automatic card brand detection CheckoutBrandDetectionType Default value is REGEX.
- Parameters:
brandDetectionType- The type of automatic card brand detection.- Returns:
A reference to this object.
-
getBrandDetectionAppearanceStyle
@NonNull() CheckoutBrandDetectionAppearanceStyle getBrandDetectionAppearanceStyle()
Returns the brand detection appearance style.
- Returns:
-
setBrandDetectionAppearanceStyle
@NonNull() CheckoutSettings setBrandDetectionAppearanceStyle(@NonNull() CheckoutBrandDetectionAppearanceStyle brandDetectionAppearanceStyle)
Sets the brand detection appearance style CheckoutBrandDetectionAppearanceStyle Default value is ACTIVE.
- Parameters:
brandDetectionAppearanceStyle- The brand detection appearance style.- Returns:
A reference to this object.
-
getBrandDetectionPriority
@Nullable() List<String> getBrandDetectionPriority()
Returns the preferred order of the detected card brands to be shown under the card number text field. By default order from paymentBrands is used.
- Returns:
The preferred order of the detected card brands.
-
setBrandDetectionPriority
@NonNull() CheckoutSettings setBrandDetectionPriority(@Nullable() List<String> brandDetectionPriority)
Sets the preferred order of the detected card brands to be shown under the card number text field.
- Parameters:
brandDetectionPriority- The list of the card brands.- Returns:
A reference to this object.
-
getSamsungPayConfig
@Nullable() SamsungPayConfig getSamsungPayConfig()
Returns the SamsungPay configuration.
- Returns:
The SamsungPay Config.
-
setSamsungPayConfig
@NonNull() CheckoutSettings setSamsungPayConfig(@Nullable() SamsungPayConfig samsungPayConfig)
Sets the SamsungPay configuration.
- Parameters:
samsungPayConfig- The SamsungPay configuration.- Returns:
A reference to this object.
-
getCustomLogos
@NonNull() Map<String, Integer> getCustomLogos()
Returns custom logos to be applied at the checkout.
- Returns:
The custom logos to be applied at the checkout.
-
getBillingAddress
@Nullable() BillingAddress getBillingAddress()
Returns the billing address which holds the address of the customer.
- Returns:
The BillingAddress.
-
setBillingAddress
@NonNull() CheckoutSettings setBillingAddress(@Nullable() BillingAddress billingAddress)
Sets the billing address which holds the address of the customer.
- Parameters:
billingAddress- The BillingAddress.- Returns:
A reference to this object.
-
getComponentName
@Nullable() ComponentName getComponentName()
Returns the component name to handle intents from CheckoutActivity.
- Returns:
The component name.
-
setComponentName
@Deprecated()@NonNull() CheckoutSettings setComponentName(@Nullable() ComponentName componentName)
Sets the component name to handle intents from CheckoutActivity.
- Parameters:
componentName- The ComponentName defines a specific android.content.BroadcastReceiver to handle the intents from CheckoutActivity.- Returns:
A reference to this object.
-
getThreeDS2Config
@Nullable() ThreeDSConfig getThreeDS2Config()
Returns the configuration object to be used during service initialization.
- Returns:
The configuration object to be used during service initialization.
-
setThreeDS2Config
@NonNull() CheckoutSettings setThreeDS2Config(@Nullable() ThreeDSConfig threeDS2Config)
Sets configuration information that shall be used during initialization.
- Parameters:
threeDS2Config- The object containing configuration information to be applied during the initialization.- Returns:
A reference to this object.
-
getWpwlOptions
@Nullable() Map<String, WpwlOptions> getWpwlOptions()
Get payment brand and its WPWL configuration for checkout.
- Returns:
The map containing payment brand as String and its WPWL configuration.
-
setWpwlOptions
@NonNull() CheckoutSettings setWpwlOptions(@Nullable() Map<String, WpwlOptions> wpwlOptions)
Set WPWL configuration information for specified brand. Payment brand should be used as key and relevant WPWL configuration as value.
- Parameters:
wpwlOptions- The map containing payment brand as String and its WPWL configuration.- Returns:
A reference to this object.
-
getUiComponentsConfig
@Nullable() UiComponentsConfig getUiComponentsConfig()
Returns the UI Components configuration.
- Returns:
The UI Components configuration.
-
setUiComponentsConfig
@NonNull() CheckoutSettings setUiComponentsConfig(@Nullable() UiComponentsConfig uiComponentsConfig)
Sets the UI Components configuration.
- Parameters:
uiComponentsConfig- The UI Components configuration.- Returns:
A reference to this object.
-
getMbWayConfig
@Nullable() MbWayConfig getMbWayConfig()
Returns the configuration for MBWAY payment method.
- Returns:
The MbWayConfig.
-
setMbWayConfig
@NonNull() CheckoutSettings setMbWayConfig(@Nullable() MbWayConfig mbWayConfig)
Sets the configuration for MBWAY payment method.
- Parameters:
mbWayConfig- The MbWayConfig.- Returns:
A reference to this object.
-
getGooglePaySubmit
@Nullable() EnumSet<GooglePaySubmitType> getGooglePaySubmit()
Get GooglePaySubmitType details submitted with payment request if information available in Google Pay payment response. Billing and Customer details are supported to be submitted with payment request.
- Returns:
Set containing GooglePaySubmitType which will be submitted with payment request if values received from Google Pay payment response.
-
setGooglePaySubmit
@NonNull() CheckoutSettings setGooglePaySubmit(@NonNull() EnumSet<GooglePaySubmitType> googlePaySubmit)
Sets values GooglePaySubmitType details submitted with payment request if information available in Google Pay payment response. Billing and Customer details are supported to be submitted with payment request.
- Parameters:
googlePaySubmit- The EnumSet containing values GooglePaySubmitType- Returns:
A reference of this object.
-
getAfterpayPacificConfig
@Nullable() AfterpayPacificConfig getAfterpayPacificConfig()
Returns the configuration for AFTERPAY_PACIFIC payment method if it is set.
- Returns:
The configuration for AFTERPAY_PACIFIC payment method if it is set, otherwise
null.
-
setAfterpayPacificConfig
@NonNull() CheckoutSettings setAfterpayPacificConfig(@Nullable() AfterpayPacificConfig afterpayPacificConfig)
Sets the configuration for AFTERPAY_PACIFIC payment method.
- Parameters:
afterpayPacificConfig- The AfterpayPacificConfig.- Returns:
A reference of this object.
-
getBrandConfig
@Nullable() CheckoutPaymentBrandConfig getBrandConfig()
Returns the configuration for brands, if it is set.
- Returns:
The configuration for Brands, if it is set, otherwise
null.
-
setBrandConfig
@NonNull() CheckoutSettings setBrandConfig(@Nullable() CheckoutPaymentBrandConfig config)
Sets the configuration for all the payment brands.
- Parameters:
config- The CheckoutPaymentBrandConfig.- Returns:
A reference of this object.
-
getPayToPayIdTypes
@NonNull() List<PayToPayIdType> getPayToPayIdTypes()
Returns the order of PayTo brand's PayId Type.
- Returns:
The order of PayTo brand's PayId Type, if it is set, otherwise all values will be considered as listed in the below order. - MOBILE - EMAIL - ACCOUNT_NUMBER
-
setPayToPayIdTypes
CheckoutSettings setPayToPayIdTypes(@Nullable() List<PayToPayIdType> payToPayIdTypes)
Sets the PayTo brand's PayId Type. Order of insertion will be considered as display order.
- Parameters:
payToPayIdTypes- The <.- Returns:
A reference of this object.
-
getThemeResId
int getThemeResId()
Return the theme resource id for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, or 0 if no resource id has been assigned.
- Returns:
The theme resource id.
-
setThemeResId
@NonNull() CheckoutSettings setThemeResId(int themeResId)
Sets a theme resource id for com.oppwa.mobile.connect.checkout.dialog.CheckoutActivity, you can also set theme in your
AndroidManifest.xml.- Parameters:
themeResId- The theme resource id.- Returns:
A reference to this object.
-
getKlarnaInvoiceFee
double getKlarnaInvoiceFee()
Returns the fee for Klarna Invoice payment method.
- Returns:
The fee for Klarna Invoice payment method.
-
setKlarnaInvoiceFee
@NonNull() CheckoutSettings setKlarnaInvoiceFee(double klarnaInvoiceFee)
Sets the fee for Klarna Invoice payment method.
- Returns:
A reference to this object.
-
getKlarnaInstallmentsFee
double getKlarnaInstallmentsFee()
Returns the fee for Klarna Installments payment method.
- Returns:
The fee for Klarna Installments payment method.
-
setKlarnaInstallmentsFee
@NonNull() CheckoutSettings setKlarnaInstallmentsFee(double klarnaInstallmentsFee)
Sets the fee for Klarna Installments payment method.
- Returns:
A reference to this object.
-
isBackButtonAvailable
boolean isBackButtonAvailable()
Returns
falseif back button must be disabled for the payment button's payment brand,trueotherwise.- Returns:
The
falseif back button must be disabled for the payment button's payment brand,trueotherwise.
-
setBackButtonAvailable
@NonNull() CheckoutSettings setBackButtonAvailable(boolean backButtonAvailable)
Sets
falseto disable back button for payment button's payment brand, otherwisetrue.- Parameters:
backButtonAvailable- Thefalseto disable back button for payment button's payment brand, otherwisetrue.- Returns:
A reference to this object.
-
isWindowSecurityEnabled
boolean isWindowSecurityEnabled()
If
truetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displaysfalseotherwise.- Returns:
If
truetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displaysfalseotherwise.
-
setWindowSecurityEnabled
@NonNull() CheckoutSettings setWindowSecurityEnabled(boolean windowSecurityEnabled)
If
truetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displaysfalseotherwise. Make sure you usefalseonly for testing purposes. It must betruefor production.- Parameters:
windowSecurityEnabled- Iftruetreat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.- Returns:
A reference to this object.
-
isSTCPayQrCodeRequired
boolean isSTCPayQrCodeRequired()
If
trueSTC pay payment method will show QR code optionfalseotherwise.- Returns:
If
trueSTC pay payment method will show QR code optionfalseotherwise.
-
setSTCPayQrCodeRequired
@NonNull() CheckoutSettings setSTCPayQrCodeRequired(boolean stcPayQrCodeRequired)
If
trueSTC pay payment method will show QR code optionfalseotherwise.- Parameters:
stcPayQrCodeRequired- IftrueSTC pay payment method will show QR code optionfalseotherwise- Returns:
A reference to this object.
-
isShowOtpEnabled
boolean isShowOtpEnabled()
Returns the boolean indicates if
trueBlik OTP will be displayed on Blik payment UI. Otherwise payment is processed without Blik code as asynchronous transaction.- Returns:
If
trueBlik code will be displayed on Blik payment UI, otherwisefalse.
-
setShowOtpEnabled
@NonNull() CheckoutSettings setShowOtpEnabled(boolean showOtpEnabled)
Sets the boolean indicates if
truedisplay Blik OTP will be displayed on Blik payment UI. Otherwise payment is processed without Blik code as asynchronous transaction.- Parameters:
showOtpEnabled- Iftruedisplay Blik code will be displayed on Blik payment UI.- Returns:
A reference of this object.
-
isCardScanningEnabled
boolean isCardScanningEnabled()
Indicates if card scanning feature (NFC/Camera) is enabled.
- Returns:
The
trueif card scanning feature is enabled, otherwisefalse.
-
setCardScanningEnabled
@NonNull() CheckoutSettings setCardScanningEnabled(boolean cardScanningEnabled)
Enables or disables the card scanning feature. This feature has two options: NFC and Camera. If it's enabled and device has NFC module, then NFC card reader will be used. If it's enabled and device has no NFC module, then Card IO will be used if it's available.
- Parameters:
cardScanningEnabled- Thetrueif card scanning feature enabled, otherwisefalse.- Returns:
A reference to this object.
-
isCardHolderVisible
boolean isCardHolderVisible()
If
trueholder name field is visible on the card payment formfalseotherwise.- Returns:
If
trueholder name field is visible on the card payment form.
-
setCardHolderVisible
@NonNull() CheckoutSettings setCardHolderVisible(boolean cardHolderVisible)
Set
trueto show holder name field on the card payment formfalseto hide the field.- Parameters:
cardHolderVisible- Iftrueholder name field is visible on the card payment form.- Returns:
A reference to this object.
-
isInstallmentEnabled
boolean isInstallmentEnabled()
Returns
trueif payments by installments are enabled, otherwisefalse.- Returns:
The
trueif payments by installments are enabled, otherwisefalse.
-
setInstallmentEnabled
@NonNull() CheckoutSettings setInstallmentEnabled(boolean installmentEnabled)
Set
trueto display dropdown with getInstallmentOptions in the card payment form.- Parameters:
installmentEnabled- Thetrueto display dropdown with getInstallmentOptions in the card payment form.- Returns:
A reference to this object.
-
isTotalAmountRequired
boolean isTotalAmountRequired()
Returns
trueif total amount should be displayed in the checkout form;falseotherwise.- Returns:
The
trueif total amount should be displayed in the checkout form;falseotherwise.
-
setTotalAmountRequired
@NonNull() CheckoutSettings setTotalAmountRequired(boolean totalAmountRequired)
If
truetotal amount will be shown on the payment method selection screen and in the 'Pay' buttons,falseotherwise.- Parameters:
totalAmountRequired- Thetruetotal amount should be displayed in the checkout form.- Returns:
A reference to this object.
-
isIBANRequired
boolean isIBANRequired()
If
trueGiropay payment method will show IBAN fieldfalseotherwise.- Returns:
If
trueGiropay payment method will show IBAN field.
-
setIBANRequired
@NonNull() CheckoutSettings setIBANRequired(boolean ibanRequired)
If
trueGiropay payment method will show IBAN fieldfalseotherwise.- Parameters:
ibanRequired- IftrueGiropay payment method will show IBAN field.- Returns:
A reference to this object.
-
isPaymentBrandsOrderUsedForTokens
boolean isPaymentBrandsOrderUsedForTokens()
Indicates if payment brands order is used for tokens on payment method selection screen.
- Returns:
The
trueif payment brands order is used, otherwisefalse.
-
setPaymentBrandsOrderUsedForTokens
@NonNull() CheckoutSettings setPaymentBrandsOrderUsedForTokens(boolean isPaymentBrandsOrderUsedForTokens)
Set if payment brands order should be used for tokens on payment method selection screen.
- Parameters:
isPaymentBrandsOrderUsedForTokens- Thetrueif payment brands order is used, otherwisefalse.- Returns:
A reference to this object.
-
isShowBirthDate
boolean isShowBirthDate()
If
trueRatepay payment method will show Date of birth input filedfalseotherwise.- Returns:
If
trueRatepay payment method will show Date of birth input filedfalseotherwise.
-
setShowBirthDate
@NonNull() CheckoutSettings setShowBirthDate(boolean showBirthDate)
If
trueRatepay payment method will show Date of birth input filedfalseotherwise.- Parameters:
showBirthDate- IftrueRatepay payment method will show date of birth input filedfalseotherwise.- Returns:
A reference to this object.
-
isCardExpiryDateValidationDisabled
boolean isCardExpiryDateValidationDisabled()
Indicates if card expiry date validation is disabled.
- Returns:
The
trueif card expiry date validation is disabled otherwisefalse.
-
setCardExpiryDateValidationDisabled
@NonNull() CheckoutSettings setCardExpiryDateValidationDisabled(boolean cardExpiryDateValidationDisabled)
Set card expiry date validation, if
truecard expiry validation will be disabled,falseotherwise.- Parameters:
cardExpiryDateValidationDisabled- Enable/disable card expiry date validation.- Returns:
A reference to this object.
-
getDisablePayNowButtonOnError
boolean getDisablePayNowButtonOnError()
Indicates if pay now button validation is enabled.
- Returns:
The
trueif pay now button validation is enabled, otherwisefalse.
-
setDisablePayNowButtonOnError
@NonNull() CheckoutSettings setDisablePayNowButtonOnError(boolean disablePayNowButtonOnError)
Set
trueto enable pay now button validation,falseto disable it. default value isfalse- Parameters:
disablePayNowButtonOnError- Thetrueto enable pay now button validation.- Returns:
A reference to this object.
-
getSecurityPolicyModeForBrand
@Nullable() CheckoutSecurityPolicyMode getSecurityPolicyModeForBrand(@NonNull() String paymentBrand)
Returns security policy mode for specific payment brand.
- Parameters:
paymentBrand- The payment brand.- Returns:
The CheckoutSecurityPolicyMode for brand or null if it is not set.
-
setSecurityPolicyModeForBrand
@NonNull() CheckoutSettings setSecurityPolicyModeForBrand(@NonNull() String paymentBrand, @NonNull() CheckoutSecurityPolicyMode securityPolicyMode)
Sets security policy mode for specific payment brand.
- Parameters:
paymentBrand- The payment brand.securityPolicyMode- The CheckoutSecurityPolicyMode.- Returns:
A reference to this object.
-
setCustomLogo
@NonNull() CheckoutSettings setCustomLogo(@NonNull() String paymentBrand, int resourceId)
Sets custom logo to be presented at the checkout for the specified payment brand.
- Parameters:
paymentBrand- The payment brand to assign custom logo for.resourceId- The resource id of the logo image, e.g.- Returns:
A reference to this object.
-
describeContents
int describeContents()
The part of Parcelable implementation.
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
The part of Parcelable implementation.
-
hashCode
int hashCode()
-
-
-
-