Terminal-2 icon

Get-started and go-live checklists for Android

Get ready for building and testing your Android Mobile solution and going live.

This page gives an overview of what needs to be done to be able to build and test a Mobile solution, and to be able to go live with a Mobile solution. There is also an overview of steps to take if you want to add docks to your card reader integration.

Our Mobile solutions are not a replacement for our traditional terminals. We are actively working towards use case and feature parity. Geographical availability may differ per solution.

Get-started checklist

  1. Choose your Android Mobile solution: your own SDK-enabled app for Tap to Pay or Card reader (or both), or Tap to Pay through the Adyen Payments app.

    Take into account the countries/regions, payment methods, and features that we support, as well as the hardware and software requirements for Android.

  2. If you are new to Adyen, see Get started with Adyen and set up your Adyen test account.

    For details, see Set up your account for in-person payments, and if applicable, see "Account structure and resources" for platforms.

  3. Ask our Support Team to enable your Adyen test account for using our Mobile solutions.

  4. In your test Customer Area:

    • Order a test card, if you do not already have one.

    • If you decided for the card reader solution, order a test NYC1 card reader.

  5. Ensure that you have a supported Android mobile device that you can use for testing.

  6. Ensure that you have an Android mobile POS app that is integrated with Terminal API.

  7. Be aware that you need to manage additional dependencies related to expiry of the Mobile SDK or the Payments app and changes in the minimum required Android version.

  8. Build your solution.

    If you are building an SDK integration, we recommend calling the warm-up function to ensure that the SDK is ready to take transactions. See Tap to Pay or Card reader.

  9. Test your solution.

Go-live checklist

  1. If you are new to Adyen, apply for a live account.

  2. Get in touch with your Adyen contact to sign the contract addendum that specifies the terms and conditions for the use of Adyen Mobile solutions, and to set up pricing.

  3. If you use our card reader solution, inform Adyen about your rollout plan and the forecasted number of card readers and (if applicable) docks that you will need.

  4. Ask our Support Team to configure your live account for using our Mobile solutions.

  5. Ensure you know when the Payment app or the SDK, the Android version, and the card reader firmware (if applicable) must be updated:

    Each SDK version expires after six months, and it is possible that the minimum required OS version changes over time.

    1. Ensure your organization has a process to distribute the software and to keep the software up to date. See Manage your Android Mobile solution.
    2. In your Customer Area, subscribe to system messages to receive email alerts about mandatory updates like changes in the minimum required Android version, Android payments app and SDK, and card reader releases.
    3. Keep up-to-date with changes in our Release notes.
    4. Implement the diagnosis request so that you can check each device for the expiry date of the installed SDK.
    5. If you are using our card reader solution, implement the relevant Device Manager function to alert users to available firmware updates.

  6. Ensure that all your mobile devices are compliant with the hardware and software requirements and can be easily upgraded.

  7. Update your API credentials and code.

    Select the tab that matches your solution:

  8. Test the live solution by doing penny tests.

  9. Ensure your personnel knows how to initiate transactions on the mobile device, how to handle error messages, and if applicable how to use the NYC1 card reader with or without an NYC1 dock.

Checklist to add a dock

If you decided to use the NYC1 card reader in your Mobile solution, you can add the NYC1 dock. The dock provides a way to:

  • Charge the card reader.
  • Charge the mobile device, if that is connected to the dock with a USB-C cable.
  • Optionally establish a USB connection instead of a Bluetooth connection between your mobile device and the card reader.
  • Create a countertop arrangement.

To add docks to your solution, take into account the following:

  1. Orders: In your Customer Area, order both the NYC1 dock and a 12V/1.5A Power Delivery (PD) power adapter for the dock. The power adapter is not supplied with the dock because the adapter is region-specific. You can only use the NYC1 dock with the NYC1 power adapter from Adyen.

  2. Requirements: The dock is supported from a specific SDK version and card reader firmware version.

  3. Connecting to the dock: Your POS app needs to show if the card reader is placed in the dock and if the mobile device is connected to the card reader through Bluetooth or USB. The Mobile SDK provides built-in screens for that. For instructions, see Use the built-in UI.

    If you do not use the built-in UI, you must implement this functionality into your own custom UI. For instructions, see Build a custom UI - Connecting to the dock.

  4. Dock firmware: To keep the dock secure, you must check for new dock firmware updates regularly, and update your docks to the latest version. The Mobile SDK provides built-in screens to alert the user to firmware updates and to start the update. For instructions, see Use the built-in UI.

    If you do not use the built-in UI, you must implement this functionality into your own custom UI. For instructions, see Build a custom UI - Updating the dock firmware.

  5. End user instructions: We provide a guide with an overview of how to use the NYC1 card reader in combination with the NYC1 dock. You can utilize this, for example, to instruct your store staff.

See also