- See the countries\/regions, payment methods, and functionality that we support<\/a>.<\/li>
- Web-based POS apps are currently only supported in the US, the EU, and Australia.<\/li><\/ul><\/td>\n<\/tr>\n
\n Setup steps<\/strong><\/td>\n Before you begin: - Contact our Support Team<\/a> to enable Tap to Pay on Android and to enable the Adyen Payments app role<\/strong> for your API key. Optionally also ask them to enable unreferenced refunds<\/a>.<\/li>
- Download the Adyen Payments Test<\/a> app from the Google Play store.<\/li>
- For testing, in your Customer Area order a White-green<\/a> Adyen test card. Or you can use a Blue-green<\/a> test card v2.4 or later, if you already have that.<\/li><\/ul>
If your POS app is web-based:- Contact our Support Team<\/a> to enable receiving a short response in the browser<\/a>.<\/li>
- Configure your web server to use HTTPS and enforce a minimum security protocol of TLS 1.2 or higher<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
How it works<\/h2>\n
When building the various flows, you will use Android App Links<\/a> to call specific parts of the Android Payments app. To build an Android Payments app solution for Tap to Pay:<\/p>\n
- \n
- Build the boarding flow<\/a>. The Payments app must be boarded on every Android mobile device where the app is installed.<\/li>\n
- Build the payment flow<\/a>.<\/li>\n<\/ol>\n
In addition, do the following:<\/p>\n
- \n
- Build the reboarding flow<\/a>. Reboarding enables you to switch to processing though a different store or merchant account using the same app instance and mobile device.<\/li>\n
- Implement an API request to revoke an app instance<\/a> for cases when the mobile device is defective, stolen, or no longer needed for payments.<\/li>\n<\/ul>\n
1. Board the app<\/h2>\n
After you download the Payments app from the Google Play store to a mobile device, you need to board the Payments app on that device. Boarding is a three-step process:<\/p>\n
- \n
- \n
Check the boarding status<\/a>.
\nFrom your POS app, you call a link to check if the Payments app is boarded. If the Payments app is not boarded, you receive a \"boarding request token\".<\/p>\n<\/li>\n- \n
Authenticate the app instance<\/a>.
\nFrom your back-end, you send an API request that includes the boarding request token. In the response, you receive a one-time boarding token that is unique for the combination of Payments app instance and device.<\/p>\n<\/li>\n- \n
Finish boarding the app<\/a>.
\nFrom your POS app, you call a link that includes the boarding token. The response confirms that the Payments app is now boarded, and includes an installation ID that you need to pass in your transaction requests.<\/p>\n<\/li>\n<\/ol>\n1.1 Check the boarding status<\/h3>\n
To start the boarding flow, you call an App Link from your POS app to check if the Adyen Payments app is already boarded.<\/p>\n
- \n
- \n
From your POS app, call the link. The App Link format is as follows:
\nhttps:\/\/www.adyen.com\/test\/boarded?returnUrl=URLEncoder(your_scheme)<\/code><\/p>\nIn this format:<\/p>\n
- \n
https:\/\/www.adyen.com\/test\/<\/code> is the test base URL.<\/li>\nboarded<\/code> is the path to use for boarding checks.<\/li>\nreturnUrl<\/code> is the URL-encoded URL where you want to receive the response.<\/li>\n<\/ul>\n<\/p>\n
The following example shows how you could build the App Link in your Kotlin project.<\/p>\n
\n<\/code-sample>\n<\/div>\n <\/p>\n
\n<\/code-sample>\n<\/div>\n<\/li>\n - \n
Check the response you receive at your
returnUrl<\/code> and decide what to do next:<\/p>\n- \n
- If
boarded<\/code> is true<\/strong><\/span>: save theinstallationId<\/code>, which you will need in your payment requests. You do not need to continue with the boarding process and you are ready to make a payment<\/a>.<\/li>\n- If
boarded<\/code> is false<\/strong><\/span>: pass theinstallationId<\/code> andboardingRequestToken<\/code> to your back-end and go to step 2 of the boarding process<\/a>.<\/li>\n<\/ul>\nThe response consists of the URL-encoded base URL where you want to receive the response and the following parameters:<\/p>\n
- If
- \n
- Implement an API request to revoke an app instance<\/a> for cases when the mobile device is defective, stolen, or no longer needed for payments.<\/li>\n<\/ul>\n
- Build the payment flow<\/a>.<\/li>\n<\/ol>\n
- Configure your web server to use HTTPS and enforce a minimum security protocol of TLS 1.2 or higher<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
- Download the Adyen Payments Test<\/a> app from the Google Play store.<\/li>
- Web-based POS apps are currently only supported in the US, the EU, and Australia.<\/li><\/ul><\/td>\n<\/tr>\n
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n