Skip to main content

iOS SDK Overview

The TapOnMobile SDK is a framework designed to ease the usage of Apple Tap to Pay on iPhone functionality.

Features​

SDK Initialization

Initialize and configure the SDK

Device Preparation

Prepare the device for payment acceptance

Terminal Activation

Multiple activation methods supported

Transactions

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​

FunctionDescription
SaleMake card transaction
RefundRefund an earlier payment
ReversalCancel the last payment
QR PaymentQR Code payment methods
BLIK PaymentBLIK payment methods
Transactions HistoryAccess transaction history records
Validate TransactionValidate transaction data
Digital ReceiptGenerate and manage digital receipts
Transactions StatisticsAccess transaction analytics

Helper Functionalities​

FunctionDescription
Last TransactionReturns the last successful transaction
Transactions HistoryAccess transaction history records
Terminal InfoGet current terminal configuration and status
Contactless Reader TestTest 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.
iOS SDK Specification
Access the complete iOS SDK documentation package

System Requirements​

  • iOS 16.0 or later
  • iPhone XS or later (devices supporting Tap to Pay on iPhone)
  • Xcode 15+
  • Swift 5.9+

Getting Started​

1
Obtain SDK Access

Contact your Worldline Partner Manager to obtain SDK access credentials and the iOS SDK package.

2
Review Documentation

Review the iOS SDK Specification document for detailed integration instructions.

3
Configure Your Project

Add the SDK framework to your Xcode project and configure entitlements for Tap to Pay on iPhone.

4
Initialize SDK

Initialize the SDK with your merchant credentials and terminal configuration.

5
Implement Transactions

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)