{"title":"Card Component integration","category":"default","creationDate":1776961628,"content":"

This page explains how to add cards to your existing Android Components integration.<\/p>\n

\n

This page is for v5.0.0<\/strong><\/span>, released in October 2023. If you are using an earlier version, use the guide for earlier versions<\/a> instead.<\/p>\n<\/div>\n

Requirements<\/h2>\n

Select the server-side flow<\/a> that your integration uses:<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

API reference<\/h2>\n\n
\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Components Configuration<\/h2>\n\n
\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Optional configuration<\/h3>\n

You can include the following functions in the configuration object:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Configuration function<\/th>\nDescription<\/th>\nParameter<\/th>\n<\/tr>\n<\/thead>\n
setAddressConfiguration<\/code><\/td>\nOptions for address fields<\/a>.<\/td>\nAn AddressConfiguration<\/code> object.<\/td>\n<\/tr>\n
setHideCvc<\/code><\/td>\nIf the security code (CVC\/CVV) field is hidden.<\/td>\nhideCvc<\/code>: Boolean<\/em>
Default: false<\/strong>.<\/td>\n<\/tr>\n
setHideCvcStoredCard<\/code><\/td>\nIf the security code (CVC\/CVV) field is hidden for stored cards.<\/td>\nhideCvcStoredCard<\/code>: Boolean<\/em>
Default: false<\/strong>.<\/td>\n<\/tr>\n
setHolderNameRequired<\/code><\/td>\nIf the cardholder name is required.<\/td>\nholderNameRequired<\/code>: Boolean<\/em>
Default: false<\/strong>.<\/td>\n<\/tr>\n
setInstallmentConfiguration<\/code><\/td>\nOptions for installment payments<\/a>.<\/td>\nAn InstallmentConfiguration<\/code> object.<\/td>\n<\/tr>\n
setKcpAuthAvailability<\/code><\/td>\nOptions for the security field for Korean cards.<\/td>\nA KCPAuthVisibility<\/code> object.
Enum values:
- HIDE<\/strong>
- SHOW<\/strong><\/td>\n<\/tr>\n
setShopperReference<\/code><\/td>\nYour unique shopper reference. This is passed back to you in the PaymentComponentData<\/code> when the payment flow finishes.<\/td>\nshopperReference<\/code>: String<\/em><\/td>\n<\/tr>\n
setSocialSecurityNumberVisibility<\/code><\/td>\nFor Brazil card payments, if the CPF<\/a>\/CNPJ<\/a> social security number field is shown.<\/td>\nA SocialSecurityNumberVisibility<\/code> object.
Enum values:
- HIDE<\/strong>
- SHOW<\/strong><\/td>\n<\/tr>\n
setSupportedCardTypes<\/code><\/td>\nThe card brands or types supported for the payment. While the shopper enters their card number, supported brands or types are shown on the payment form.<\/td>\nAn array of supportCardBrands<\/code> or supportCardTypes<\/code>.
Default: PaymentMethod.brands<\/code>, if it exists. Otherwise, DEFAULT_SUPPORTED_CARDS_LIST<\/code>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

For example, to add configuration to set the Postal Code<\/strong> field to be optional for Mastercard and JCB:<\/p>\n

\n <\/code-sample>\n<\/div>\n

Address fields configuration<\/h3>\n

In the AddressConfiguration<\/code> object, you can configure the following classes:<\/p>\n