{"title":"Upgrade to Adyen Android v5","category":"default","creationDate":1682951100,"content":"

If your integration uses Android v4.13.3 and earlier, and you are upgrading it to use v5.0.0, make the following changes to your integration.<\/p>\n

Checkout API version<\/h2>\n

We recommend using Checkout API v70<\/a>.<\/p>\n

Step 1: Upgrade versions of build configuration and dependencies<\/h2>\n

Build configuration: compileSdkVersion<\/code> and targetSdkVersion<\/code><\/a>: 34<\/strong>.
\nDependencies:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nVersion<\/th>\n<\/tr>\n<\/thead>\n
Adyen 3DS2<\/a><\/td>\n2.2.15<\/strong><\/td>\n<\/tr>\n
Android Gradle plugin<\/a><\/td>\n8.1.1<\/strong><\/td>\n<\/tr>\n
Appcompat<\/a><\/td>\n1.6.1<\/strong><\/td>\n<\/tr>\n
AndroidX Browser<\/a><\/td>\n1.6.0<\/strong><\/td>\n<\/tr>\n
AndroidX Compose Bill of Materials (BOM)<\/a><\/td>\n2023.09.00<\/strong><\/td>\n<\/tr>\n
AndroidX Compose compiler<\/a><\/td>\n1.5.3<\/strong><\/td>\n<\/tr>\n
AndroidX Fragment<\/a><\/td>\n1.6.1<\/strong><\/td>\n<\/tr>\n
AndroidX Lifecycle<\/a><\/td>\n2.5.1<\/strong><\/td>\n<\/tr>\n
AndroidX Recyclerview<\/a><\/td>\n1.3.1<\/strong><\/td>\n<\/tr>\n
AndroidX Constraintlayout<\/a><\/td>\n2.1.4<\/strong><\/td>\n<\/tr>\n
Cash App Pay<\/a><\/td>\n2.3.0<\/strong><\/td>\n<\/tr>\n
Google Pay<\/a><\/td>\n19.2.1<\/strong><\/td>\n<\/tr>\n
Kotlin coroutines<\/a><\/td>\n1.6.4<\/strong><\/td>\n<\/tr>\n
Kotlin Gradle plugin<\/a><\/td>\n1.9.10<\/strong><\/td>\n<\/tr>\n
Material Design<\/a><\/td>\n1.9.0<\/strong><\/td>\n<\/tr>\n
WeChat Pay<\/a><\/td>\n6.8.0<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Step 2: Upgrade the configuration object<\/h2>\n

In your configuration object, you now must set the following properties:<\/p>\n\n\n\n\n\n\n\n\n
Property<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
amount<\/code><\/td>\nIf you want to show the amount on the Pay<\/strong> button.<\/td>\nThe currency and value of the payment amount shown on the Pay<\/strong> button.<\/td>\n<\/tr>\n
shopperLocale<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's locale. To use the device's default locale, replace this with your context.<\/td>\n<\/tr>\n
environment<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nUse Environment.TEST<\/code> for testing. When going live, use one of our live environments.<\/td>\n<\/tr>\n
clientKey<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nYour client key.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n
\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Step 3: Upgrade methods<\/h2>\n\n
\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Step 4: Upgrade launching<\/h2>\n\n
\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Step 5: Fix broken imports<\/h2>\n

Some classes are moved in this version. For most classes, the names haven't changed and you only have to re-import them. When importing the classes marked with a name change in the release notes<\/a>, you must update import statements.<\/p>\n

Public classes and functions that should not be directly used are marked as internal in this version. If you get a Restricted API<\/a> lint error on a class or function, this means it is internal and must not be used.
\nIf you believe the error you received is incorrect, report it by opening an issue on our GitHub repo<\/a>.<\/p>\n

Step 6 (optional): Upgrade your action handling implementation<\/h2>\n

For Components integrations:<\/p>\n

In this version, the payment method Components can handle the required actions. For example the card Component can handle the redirect<\/strong> and threeDS2<\/strong> actions. You do not need to implement the RedirectComponent<\/code> or the Adyen3DS2Component<\/code> to handle redirects or 3D Secure authentication for cards.<\/p>\n

If you want to handle actions on a different page than the checkout one, you can use the GenericActionComponent<\/code> instead.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/online-payments\/upgrade-your-integration\/upgrade-to-android-5-0-0","articleFields":{"description":"Find out more about the breaking changes in this release.","feedback_component":true,"filters_component":false,"last_edit_on":"30-11-2023 12:37","page_id":"af92a2d3-0b36-45f1-b5c5-89186714a2ba"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/online-payments\/upgrade-your-integration\/upgrade-to-android-5-0-0","title":"Upgrade to Adyen Android v5","content":"If your integration uses Android v4.13.3 and earlier, and you are upgrading it to use v5.0.0, make the following changes to your integration.\nCheckout API version\nWe recommend using Checkout API v70.\nStep 1: Upgrade versions of build configuration and dependencies\nBuild configuration: compileSdkVersion and targetSdkVersion: 34.\nDependencies:\n\n\n\nName\nVersion\n\n\n\n\nAdyen 3DS2\n2.2.15\n\n\nAndroid Gradle plugin\n8.1.1\n\n\nAppcompat\n1.6.1\n\n\nAndroidX Browser\n1.6.0\n\n\nAndroidX Compose Bill of Materials (BOM)\n2023.09.00\n\n\nAndroidX Compose compiler\n1.5.3\n\n\nAndroidX Fragment\n1.6.1\n\n\nAndroidX Lifecycle\n2.5.1\n\n\nAndroidX Recyclerview\n1.3.1\n\n\nAndroidX Constraintlayout\n2.1.4\n\n\nCash App Pay\n2.3.0\n\n\nGoogle Pay\n19.2.1\n\n\nKotlin coroutines\n1.6.4\n\n\nKotlin Gradle plugin\n1.9.10\n\n\nMaterial Design\n1.9.0\n\n\nWeChat Pay\n6.8.0\n\n\n\nStep 2: Upgrade the configuration object\nIn your configuration object, you now must set the following properties:\n\n\n\nProperty\nRequired\nDescription\n\n\n\n\namount\nIf you want to show the amount on the Pay button.\nThe currency and value of the payment amount shown on the Pay button.\n\n\nshopperLocale\n\nThe shopper's locale. To use the device's default locale, replace this with your context.\n\n\nenvironment\n\nUse Environment.TEST for testing. When going live, use one of our live environments.\n\n\nclientKey\n\nYour client key.\n\n\n\n\n\n \n \n \n \n\n\nStep 3: Upgrade methods\n\n\n \n \n \n \n\n\nStep 4: Upgrade launching\n\n\n \n \n \n \n\n\nStep 5: Fix broken imports\nSome classes are moved in this version. For most classes, the names haven't changed and you only have to re-import them. When importing the classes marked with a name change in the release notes, you must update import statements.\nPublic classes and functions that should not be directly used are marked as internal in this version. If you get a Restricted API lint error on a class or function, this means it is internal and must not be used.\nIf you believe the error you received is incorrect, report it by opening an issue on our GitHub repo.\nStep 6 (optional): Upgrade your action handling implementation\nFor Components integrations:\nIn this version, the payment method Components can handle the required actions. For example the card Component can handle the redirect and threeDS2 actions. You do not need to implement the RedirectComponent or the Adyen3DS2Component to handle redirects or 3D Secure authentication for cards.\nIf you want to handle actions on a different page than the checkout one, you can use the GenericActionComponent instead.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Upgrade your integration","lvl3":"Upgrade to Adyen Android v5"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/online-payments","lvl2":"https:\/\/docs.adyen.com\/pt\/online-payments\/upgrade-your-integration","lvl3":"\/pt\/online-payments\/upgrade-your-integration\/upgrade-to-android-5-0-0"},"levels":4,"category":"Online Payments","category_color":"green","tags":["Upgrade","Adyen","Android"]}}