iOS SDK Overview
The TapOnMobile SDK is a framework designed to ease the usage of Apple Tap to Pay on iPhone functionality.
Features
Initialize and configure the SDK
Prepare the device for payment acceptance
Multiple activation methods supported
Full payment transaction support
Terminal Activation Methods
The SDK supports multiple terminal activation approaches:
- Backend-to-backend terminal activation - Server-side integration
- Merchant portal terminal activation - Via web portal
- Backoffice terminal activation - Administrative activation
Supported Transactions
- Sale - Standard purchase transaction
- Refund - Return funds for a previous transaction
- Reversal - Cancel the last successful transaction
Core Functionalities
| Function | Description |
|---|---|
| Sale | Make card transaction |
| Refund | Refund an earlier payment |
| Reversal | Cancel the last payment |
| QR Payment | QR Code payment methods |
| BLIK Payment | BLIK payment methods |
| Transactions History | Access transaction history records |
| Validate Transaction | Validate transaction data |
| Digital Receipt | Generate and manage digital receipts |
| Transactions Statistics | Access transaction analytics |
Helper Functionalities
| Function | Description |
|---|---|
| SDK Version | Retrieve SDK version |
| Check Device Registered | Return registrationtion status of the device |
| Last Transaction | Returns the last successful transaction |
| Language Handling | Setup language for the UI |
| Terminal Info | Get current terminal configuration and status |
| Contactless Reader Test | Test the NFC reader functionality |
The SDK includes various helper functions to simplify integration and improve developer experience.
Documentation
For the complete iOS SDK specification, including detailed API documentation, integration guides, and code examples, please refer to the official documentation.
Access the complete iOS SDK documentation package
System Requirements
- An iOS version that has been released in the last 12 months, see https://support.apple.com/en-us/100100
- Proximity reader functionality is only available for iPhones 11 and above.
- Xcode 26.3
- Swift 5+
- Location permission enabled for transactions, with SDK helpers to ensure proper configuration.
- When using an MDM, IP Addresses have to be white listed.
Getting Started
Contact your Worldline Partner Manager to obtain SDK access credentials and the iOS SDK package.
Review the iOS SDK Specification document for detailed integration instructions.
Add the SDK framework to your Xcode project and configure entitlements for Tap to Pay on iPhone.
Initialize the SDK with your merchant credentials and terminal configuration.
Implement the transaction flows according to your business requirements.
Apple Tap to Pay on iPhone Requirements
To use Tap to Pay on iPhone, your app must meet Apple's requirements:
- Your app must be approved by Apple for Tap to Pay on iPhone
- You must have a valid payment service provider agreement
- The merchant must be in a supported region
- End users must have compatible hardware (iPhone XS or later)