To enable the Adyen iOS SDK to handle payments, you need to add code to your iOS POS app. This code starts a transaction with:
- A Terminal API payment request.
- The payment interface you want to use: your iPhone for Tap to Pay, or the card reader.
- The presentation mode you want to use.
After you have added this code, payments take place as follows:
Your POS app creates a Terminal API payment request that is serialized to JSON, or you receive the Terminal API payment request from your backend.
To help you create Terminal API payment requests, we provide a TerminalAPIKit for iOS on GitHub. Installation and usage instructions are in the repository's README.
- You pass the payment request to the Adyen iOS SDK.
- The Adyen iOS SDK checks if the session is still valid, and if necessary establishes a new session.
- The transaction starts on your mobile device.
In the card reader solution, the Adyen iOS SDK shows instructions for the customer on your mobile device.
- The Adyen iOS SDK passes the Terminal API payment response to your POS app.
Add code to start a transaction
In your POS app, add code for the following steps:
If you create the Terminal API payment request in your POS app, use
POIIDin the MessageHeader of the payment request. (If you create the payment request in the backend, the backend uses the
Create an instance of
Transaction.Request(data:), and pass the Terminal API payment request from your POS app or backend.
let transaction = try Transaction.Request(data: requestData)
PaymentInterfacefrom an instance of
Use the iPhone for Tap to Pay.
Use the card reader.
let paymentService = PaymentService(...) let paymentInterface = try paymentService .getPaymentInterface(with: .cardReader)
TransactionPresentationModethat matches the UI framework of the POS app.
The UI is embedded in a
The UI is presented on top of the provided
let presentationMode: TransactionPresentationMode = .viewModifier
PaymentService.performTransaction(with:paymentInterface:presentationMode:)on your instance of
The Adyen iOS SDK now checks for a session, and starts the transaction. In the card reader solution, the Adyen iOS SDK shows screens on your mobile device to help the customer.
let transactionResponse = await paymentService.performTransaction( with: transaction, paymentInterface: paymentInterface, presentationMode: presentationMode )
- Pass the
transactionResponseto your POS app. This is the Terminal API payment response, including data you can use to generate a receipt.