Tap to Pay on Android

With our Tap to Pay on Android solution you can accept contactless in-person payments using an Android mobile device as the payment interface, and process these payments on the plataforma de pagamentos da Adyen.

Integration effort

Integrating the Adyen POS Mobile SDK obviously requires front-end development tasks. However, when planning the work, take into account the following.

• Back-end development tasks. You need to:

  • Implement a server-to-server call to set up a secure communications session between the SDK and the plataforma de pagamentos da Adyen.
  • Integrate your POS app with Terminal API. You must support the PaymentRequest , and preferably also the ReversalRequest .

    How to integrate with Terminal API is described in other sections of our documentation.

• Cross-platform frameworks: integration of our native SDK into a cross-platform app is possible, but complex at the moment. We are working to improve the integration experience in cross-platform frameworks.

Before you start

• Ask our Support Team to configure your account for using the Adyen POS Mobile SDK for Android.
• Backend integration: make sure your Android POS app is integrated with our Terminal API.

• Make sure you have an API credential with an API key, the Checkout webservice role, and a client key.

  If your credential doesn't already have a client key, create one as follows:

  1. Log in to your Customer Area.
  2. Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
  3. Under Client settings > Authentication select the Client key tab.
  4. Select Generate client key.
  5. Select Save changes.

  The client key is part of the setup but you won't need to use it in your integration later. Therefore, you don't need to specify allowed origins, and you don't need to store the key in your system.

• Note the requirements for end users:
  • The POS app, with the SDK integrated into it, must be installed on their Android mobile device (smartphone or tablet).
  • Requirements for the mobile device:
  • Must have Android version 11 updated to the latest security patch. The minimum required security patch is the one for March 5th 2022.
  • Must have an NFC reader.
  • Must be a commercial off-the-shelve device.
  • Must not be a payment terminal.
  • Must support hardware key attestation and be Google-certified. Before purchasing mobile devices, confirm with the manufacturer that the devices support hardware key attestation. The key attestation demo app can help rule out incompatibility.

How it works

This is how the solution's components work together:

1. Your Android POS app creates a Terminal API payment request, or receives a Terminal API payment request from your backend.
2. The POS app passes the payment request to the Adyen POS Mobile SDK.
3. The customer completes the payment by tapping their card or mobile device on the NFC reader of the phone or tablet.
4. The SDK passes the Terminal API payment response to the POS app.

Steps to build the solution

To set up the Tap to Pay on Android solution:

1. Add the Adyen POS Mobile SDK to your Android POS app.
2. Add code to make payments from your POS app using the Adyen POS Mobile SDK.
3. Apply guidelines for the use of Tap to Pay on Android.