Get-started and go-live checklists

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.

Get-started checklist

1. Choose your iOS Mobile solution: Tap to Pay on iPhone or Card reader, or both.

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

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 or for marketplaces.

3. Ask our Support Team to configure your Adyen test account for using the iOS Mobile SDK.

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 iOS mobile device that you can use for testing.

6. Ensure that you have an iOS 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 and changes in the minimum required iOS 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 on iPhone or Card reader on iOS.

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 the iOS Mobile SDK.

5. Ensure you know when the SDK, the iOS, 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 iOS 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 iOS Mobile solution.
   2. In your Customer Area, subscribe to system messages to receive email alerts about mandatory updates like changes in the minimum required iOS version, 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. When going live with your Tap to Pay on iPhone or card reader solution, update your API credentials and code:

   1. In your live Customer Area, generate a live API credential with basic authentication and the Allow SDK download for POS developers role.
   2. Update your code to pull in the live version of the SDK.
   3. In your live Customer Area, generate a live API credential with an API key and the Checkout webservice role.

   4. Update your code to use the live API key and the live endpoint for establishing a communication session.

8. Optionally set a custom transaction screen text.

9. For Tap to Pay on iPhone, accept the Apple Terms of Use.

10. Test the live solution by doing penny tests.

11. 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.

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. USB permissions: You must add a key for the dock to the Info.plist of your POS app. And if you are going to submit your app to the App Store, you must send us specific details about your app so that we can provide you with an MFi PPID. For instructions, see Manage USB permissions.

6. 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