All Implemented Interfaces:: com.adyen.checkout.action.core.internal.ActionHandlingConfigurationBuilder , com.adyen.checkout.components.core.internal.ButtonConfigurationBuilder

@Deprecated(message = "Configuration builders are deprecated, use CheckoutConfiguration instead.") 
public final class CardConfiguration.Builder
extends ActionHandlingPaymentMethodConfigurationBuilder<CardConfiguration, CardConfiguration.Builder> implements ButtonConfigurationBuilder

Builder to create a CardConfiguration.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private List<CardBrand>`	`supportedCardBrands`
`private Boolean`	`isHolderNameRequired`
`private Boolean`	`isStorePaymentFieldVisible`
`private String`	`shopperReference`
`private Boolean`	`isHideCvc`
`private Boolean`	`isHideCvcStoredCard`
`private Boolean`	`isSubmitButtonVisible`
`private SocialSecurityNumberVisibility`	`socialSecurityNumberVisibility`
`private KCPAuthVisibility`	`kcpAuthVisibility`
`private InstallmentConfiguration`	`installmentConfiguration`
`private AddressConfiguration`	`addressConfiguration`

Constructor Summary

Constructors
Constructor	Description
`CardConfiguration.Builder(Environment environment, String clientKey)`	Initialize a configuration builder with the required fields.
`CardConfiguration.Builder(Context context, Environment environment, String clientKey)`	Alternative constructor that uses the context to fetch the user locale and use it as a shopper locale.
`CardConfiguration.Builder(Locale shopperLocale, Environment environment, String clientKey)`	Builder with parameters for a CardConfiguration.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<CardBrand>`	`getSupportedCardBrands()`
`final Unit`	`setSupportedCardBrands(List<CardBrand> supportedCardBrands)`
`final Boolean`	`isHolderNameRequired()`
`final Unit`	`setHolderNameRequired(Boolean isHolderNameRequired)`
`final Boolean`	`isStorePaymentFieldVisible()`
`final Unit`	`setStorePaymentFieldVisible(Boolean isStorePaymentFieldVisible)`
`final String`	`getShopperReference()`
`final Unit`	`setShopperReference(String shopperReference)`
`final Boolean`	`isHideCvc()`
`final Unit`	`setHideCvc(Boolean isHideCvc)`
`final Boolean`	`isHideCvcStoredCard()`
`final Unit`	`setHideCvcStoredCard(Boolean isHideCvcStoredCard)`
`final Boolean`	`isSubmitButtonVisible()`
`final Unit`	`setSubmitButtonVisible(@Deprecated(message = "Configure this in CheckoutConfiguration instead.") Boolean isSubmitButtonVisible)`
`final SocialSecurityNumberVisibility`	`getSocialSecurityNumberVisibility()`
`final Unit`	`setSocialSecurityNumberVisibility(SocialSecurityNumberVisibility socialSecurityNumberVisibility)`
`final KCPAuthVisibility`	`getKcpAuthVisibility()`
`final Unit`	`setKcpAuthVisibility(KCPAuthVisibility kcpAuthVisibility)`
`final InstallmentConfiguration`	`getInstallmentConfiguration()`
`final Unit`	`setInstallmentConfiguration(InstallmentConfiguration installmentConfiguration)`
`final AddressConfiguration`	`getAddressConfiguration()`
`final Unit`	`setAddressConfiguration(AddressConfiguration addressConfiguration)`
`final CardConfiguration.Builder`	`setSupportedCardTypes(CardBrand supportCardBrands)`	Set the supported card types for this payment.
`final CardConfiguration.Builder`	`setSupportedCardTypes(CardType supportCardTypes)`	Set the supported card types for this payment.
`final CardConfiguration.Builder`	`setHolderNameRequired(Boolean holderNameRequired)`	Set if the holder name is required and should be shown as an input field.
`final CardConfiguration.Builder`	`setShowStorePaymentField(Boolean showStorePaymentField)`	Set if the option to store the card for future payments should be shown as an input field.
`final CardConfiguration.Builder`	`setShopperReference(String shopperReference)`	Set the unique reference for the shopper doing this transaction.
`final CardConfiguration.Builder`	`setHideCvc(Boolean hideCvc)`	Set if the CVC field should be hidden from the Component and not requested to the shopper on a regular payment.
`final CardConfiguration.Builder`	`setHideCvcStoredCard(Boolean hideCvcStoredCard)`	Set if the CVC field should be hidden from the Component and not requested to the shopper on a stored payment flow.
`final CardConfiguration.Builder`	`setSocialSecurityNumberVisibility(SocialSecurityNumberVisibility socialSecurityNumberVisibility)`	Set if CPF/CNPJ field for Brazil merchants should be visible or not.
`final CardConfiguration.Builder`	`setKcpAuthVisibility(KCPAuthVisibility kcpAuthVisibility)`	Set if security fields for Korean cards should be visible or not.
`final CardConfiguration.Builder`	`setInstallmentConfigurations(InstallmentConfiguration installmentConfiguration)`	Configures the installment options to be provided to the shopper.
`final CardConfiguration.Builder`	`setAddressConfiguration(AddressConfiguration addressConfiguration)`	Configures the address form to be shown to the shopper.
`CardConfiguration.Builder`	`setSubmitButtonVisible(Boolean isSubmitButtonVisible)`	Sets if submit button will be visible or not.

Methods inherited from class com.adyen.checkout.action.core.internal.ActionHandlingPaymentMethodConfigurationBuilder
add3ds2ActionConfiguration, addAwaitActionConfiguration, addQRCodeActionConfiguration, addRedirectActionConfiguration, addTwintActionConfiguration, addVoucherActionConfiguration, addWeChatPayActionConfiguration
Methods inherited from class com.adyen.checkout.components.core.internal.BaseConfigurationBuilder
build, setAmount, setAnalyticsConfiguration, setShopperLocale
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CardConfiguration.Builder
```
CardConfiguration.Builder(Environment environment, String clientKey)
```
    Initialize a configuration builder with the required fields.
    
    Parameters:
    
    environment - The Environment to be used for internal network calls from the SDK to Adyen.
    
    clientKey - Your Client Key used for internal network calls from the SDK to Adyen.
  - CardConfiguration.Builder
```
CardConfiguration.Builder(Context context, Environment environment, String clientKey)
```
    Alternative constructor that uses the context to fetch the user locale and use it as a shopper locale.
    
    Parameters:
    
    context - A Context
    
    environment - The Environment to be used for internal network calls from the SDK to Adyen.
    
    clientKey - Your Client Key used for internal network calls from the SDK to Adyen.
  - CardConfiguration.Builder
```
CardConfiguration.Builder(Locale shopperLocale, Environment environment, String clientKey)
```
    Builder with parameters for a CardConfiguration.
    
    Parameters:
    
    shopperLocale - The Locale of the shopper.
    
    environment - The Environment to be used for internal network calls from the SDK to Adyen.
    
    clientKey - Your Client Key used for internal network calls from the SDK to Adyen.
- Method Detail
  - getSupportedCardBrands
```
 final List<CardBrand> getSupportedCardBrands()
```
  - setSupportedCardBrands
```
 final Unit setSupportedCardBrands(List<CardBrand> supportedCardBrands)
```
  - isHolderNameRequired
```
 final Boolean isHolderNameRequired()
```
  - setHolderNameRequired
```
 final Unit setHolderNameRequired(Boolean isHolderNameRequired)
```
  - isStorePaymentFieldVisible
```
 final Boolean isStorePaymentFieldVisible()
```
  - setStorePaymentFieldVisible
```
 final Unit setStorePaymentFieldVisible(Boolean isStorePaymentFieldVisible)
```
  - getShopperReference
```
 final String getShopperReference()
```
  - setShopperReference
```
 final Unit setShopperReference(String shopperReference)
```
  - isHideCvc
```
 final Boolean isHideCvc()
```
  - setHideCvc
```
 final Unit setHideCvc(Boolean isHideCvc)
```
  - isHideCvcStoredCard
```
 final Boolean isHideCvcStoredCard()
```
  - setHideCvcStoredCard
```
 final Unit setHideCvcStoredCard(Boolean isHideCvcStoredCard)
```
  - isSubmitButtonVisible
```
 final Boolean isSubmitButtonVisible()
```
  - setSubmitButtonVisible
```
 final Unit setSubmitButtonVisible(@Deprecated(message = "Configure this in CheckoutConfiguration instead.") Boolean isSubmitButtonVisible)
```
  - getSocialSecurityNumberVisibility
```
 final SocialSecurityNumberVisibility getSocialSecurityNumberVisibility()
```
  - setSocialSecurityNumberVisibility
```
 final Unit setSocialSecurityNumberVisibility(SocialSecurityNumberVisibility socialSecurityNumberVisibility)
```
  - getKcpAuthVisibility
```
 final KCPAuthVisibility getKcpAuthVisibility()
```
  - setKcpAuthVisibility
```
 final Unit setKcpAuthVisibility(KCPAuthVisibility kcpAuthVisibility)
```
  - getInstallmentConfiguration
```
 final InstallmentConfiguration getInstallmentConfiguration()
```
  - setInstallmentConfiguration
```
 final Unit setInstallmentConfiguration(InstallmentConfiguration installmentConfiguration)
```
  - getAddressConfiguration
```
 final AddressConfiguration getAddressConfiguration()
```
  - setAddressConfiguration
```
 final Unit setAddressConfiguration(AddressConfiguration addressConfiguration)
```
  - setSupportedCardTypes
```
 final CardConfiguration.Builder setSupportedCardTypes(CardBrand supportCardBrands)
```
    Set the supported card types for this payment. Supported types will be shown as user inputs the card number.
    Defaults to PaymentMethod.brands if it exists, or DEFAULT_SUPPORTED_CARDS_LIST otherwise.
    Use this method when adding supported types that are not inside the CardType enum.
    
    Parameters:
    
    supportCardBrands - array of CardBrand
    
    Returns:
    
    CardConfiguration.Builder
  - setSupportedCardTypes
```
 final CardConfiguration.Builder setSupportedCardTypes(CardType supportCardTypes)
```
    Set the supported card types for this payment. Supported types will be shown as user inputs the card number.
    Defaults to PaymentMethod.brands if it exists, or DEFAULT_SUPPORTED_CARDS_LIST otherwise.
    
    Parameters:
    
    supportCardTypes - array of CardType
    
    Returns:
    
    CardConfiguration.Builder
  - setHolderNameRequired
```
 final CardConfiguration.Builder setHolderNameRequired(Boolean holderNameRequired)
```
    Set if the holder name is required and should be shown as an input field.
    Default is false.
    
    Parameters:
    
    holderNameRequired - Boolean
    
    Returns:
    
    CardConfiguration.Builder
  - setShowStorePaymentField
```
 final CardConfiguration.Builder setShowStorePaymentField(Boolean showStorePaymentField)
```
    Set if the option to store the card for future payments should be shown as an input field.
    Default is true.
    Not applicable for the sessions flow. Check out the Sessions API documentation on how to set this value.
    
    Parameters:
    
    showStorePaymentField - Boolean
    
    Returns:
    
    CardConfiguration.Builder
  - setShopperReference
```
 final CardConfiguration.Builder setShopperReference(String shopperReference)
```
    Set the unique reference for the shopper doing this transaction. This value will simply be passed back to you in the PaymentComponentData for convenience.
    
    Parameters:
    
    shopperReference - The unique shopper reference
    
    Returns:
    
    CardConfiguration.Builder
  - setHideCvc
```
 final CardConfiguration.Builder setHideCvc(Boolean hideCvc)
```
    Set if the CVC field should be hidden from the Component and not requested to the shopper on a regular payment. Note that this might have implications for the risk of the transaction. Talk to Adyen Support before enabling this.
    Default is false.
    
    Parameters:
    
    hideCvc - If CVC should be hidden or not.
    
    Returns:
    
    CardConfiguration.Builder
  - setHideCvcStoredCard
```
 final CardConfiguration.Builder setHideCvcStoredCard(Boolean hideCvcStoredCard)
```
    Set if the CVC field should be hidden from the Component and not requested to the shopper on a stored payment flow. Note that this has implications for the risk of the transaction. Talk to Adyen Support before enabling this.
    Default is false.
    
    Parameters:
    
    hideCvcStoredCard - If CVC should be hidden or not for stored payments.
    
    Returns:
    
    CardConfiguration.Builder
  - setSocialSecurityNumberVisibility
```
 final CardConfiguration.Builder setSocialSecurityNumberVisibility(SocialSecurityNumberVisibility socialSecurityNumberVisibility)
```
    Set if CPF/CNPJ field for Brazil merchants should be visible or not.
    Default is SocialSecurityNumberVisibility.HIDE.
    
    Parameters:
    
    socialSecurityNumberVisibility - If CPF/CNPJ field should be visible or not.
    
    Returns:
    
    CardConfiguration.Builder
  - setKcpAuthVisibility
```
 final CardConfiguration.Builder setKcpAuthVisibility(KCPAuthVisibility kcpAuthVisibility)
```
    Set if security fields for Korean cards should be visible or not.
    Default is KCPAuthVisibility.HIDE.
    
    Parameters:
    
    kcpAuthVisibility - If security fields for Korean cards should be visible or not.
    
    Returns:
    
    CardConfiguration.Builder
  - setInstallmentConfigurations
```
 final CardConfiguration.Builder setInstallmentConfigurations(InstallmentConfiguration installmentConfiguration)
```
    Configures the installment options to be provided to the shopper.
    Not applicable for the sessions flow. Check out the Sessions API documentation on how to set this value.
    
    Parameters:
    
    installmentConfiguration - The configuration object for installment options.
    
    Returns:
    
    CardConfiguration.Builder
  - setAddressConfiguration
```
 final CardConfiguration.Builder setAddressConfiguration(AddressConfiguration addressConfiguration)
```
    Configures the address form to be shown to the shopper.
    Default is AddressConfiguration.None.
    
    Parameters:
    
    addressConfiguration - The configuration object for address form.
    
    Returns:
    
    CardConfiguration.Builder
  - setSubmitButtonVisible
```
 CardConfiguration.Builder setSubmitButtonVisible(Boolean isSubmitButtonVisible)
```
    Sets if submit button will be visible or not.
    Default is True.
    
    Parameters:
    
    isSubmitButtonVisible - Is submit button should be visible or not.

Class CardConfiguration.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.adyen.checkout.action.core.internal.ActionHandlingPaymentMethodConfigurationBuilder

Methods inherited from class com.adyen.checkout.components.core.internal.BaseConfigurationBuilder

Methods inherited from class java.lang.Object

Constructor Detail

CardConfiguration.Builder

CardConfiguration.Builder

CardConfiguration.Builder

Method Detail

getSupportedCardBrands

setSupportedCardBrands

isHolderNameRequired

setHolderNameRequired

isStorePaymentFieldVisible

setStorePaymentFieldVisible

getShopperReference

setShopperReference

isHideCvc

setHideCvc

isHideCvcStoredCard

setHideCvcStoredCard

isSubmitButtonVisible

setSubmitButtonVisible

getSocialSecurityNumberVisibility

setSocialSecurityNumberVisibility

getKcpAuthVisibility

setKcpAuthVisibility

getInstallmentConfiguration

setInstallmentConfiguration

getAddressConfiguration

setAddressConfiguration

setSupportedCardTypes

setSupportedCardTypes

setHolderNameRequired

setShowStorePaymentField

setShopperReference

setHideCvc

setHideCvcStoredCard

setSocialSecurityNumberVisibility

setKcpAuthVisibility

setInstallmentConfigurations

setAddressConfiguration

setSubmitButtonVisible