Tap to Pay on iPhone

With our Tap to Pay on iPhone solution you can accept contactless in-person payments using an iPhone 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

• Get in touch with your Adyen contact and sign the contract addendum that specifies the terms and conditions for the use of Tap to Pay on iPhone.
• Ask our Support Team to configure your account for Tap to Pay on iPhone payments.
• Backend integration: make sure your POS app is integrated with our Terminal API.

• Make sure that 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 do not need to specify allowed origins, and you do not need to store the key in your system.

• To test Tap to Pay in our test environment, create a Sandbox Apple ID.
• Check the requirements. Specifically:
  • Xcode version 15.3 or later
  • SDK version 2.2.0 or later
  • An iPhone Xs or later with iOS version 17.0 or later
• Optionally have a look at these resources for Tap to Pay on iPhone:
  • Demo
  • Apple developer page
  • Frequently asked questions

How it works

This is how the solution's components work together:

1. Your iOS POS app creates a Terminal API payment request.
2. The POS app passes the payment request to the Adyen POS Mobile SDK for iOS.
3. The SDK passes the request to the Tap to Pay on iPhone component.
4. The customer completes the payment by tapping their card or mobile device on the iPhone.
5. 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 iPhone solution:

1. Get an entitlement from Apple for Tap to Pay on iPhone.
2. Add the Adyen POS Mobile SDK to your project and implement a server-to-server authentication call.
3. Add code to handle transactions from your POS app using the SDK.
4. Implement UI guidelines from Apple for presenting the Tap to Pay screen.