Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 3.83 KB

README.md

File metadata and controls

82 lines (51 loc) · 3.83 KB
Raw

Tyro Tap to Pay SDK (iOS)

iOS SDK for Tap To Pay on iPhone using Tyro Payments as the Payment Service Provider (PSP)

Swift Static Badge Static Badge

Requirements

  • Xcode or above
  • iPhone with Tap to Pay on iPhone hardware capability (iPhone XS or above)
  • iOS 17.0 or above

Installation

This project requires Xcode. You can see all the Xcode releases and version info at Xcode Releases

Make sure, you have the correct version of the Xcode command line tools installed:

    xcode-select --install

Sample iOS App

Refer to The SampleApp source code for a working example iOS app integrating with Tyro's SDK for Tap to Pay on iPhone.

Using the Swift Package in your iOS app

Entitlements

You must request access to the Tap to Pay on iPhone entitlement from Apple directly, refer to Apple's proximity reader documentation for more information.

Steps to get up and running with the SDK

Create necessary certificates and provisioning profiles

Configure your iOS project

  1. Setup Code Signing and Provisioning Profiles in your Xcode project;
  2. Ensure the Bundle identifier matches the format that you will use for code signing;
  3. Configure the team for each target within the project and ensure it is consistent with your Code Signing configuration.
  4. Add the Tap to Pay on iPhone entitlement, note this will appear in the list of available options when code signing is correctly configured.
  5. Add the tyro-tap-to-pay-ios Swift Package to your project;
  6. Add the (Tyro provided) environment config (.env) file to your project's Supporting Files sub-directory and add keys to the project info plist (detailed in the documentation);
  7. Import TyroTapToPaySDK in your source code
  8. Create an instance of the TyroTapToPay class:
    • Inject the TyroEnvironment and your ConnectionProvider implementation
    • Call the connect() method of the TyroTapToPay instance.

For more details, refer to the Documentation.

Documentation

Developing a POS app for integrating with Tyro Tap to Pay SDK (iOS)

A preview of our API documentation can be found here:

Marketing Guidelines

Refer to Apple's Tap to Pay Marketing Guidelines

Need help?

Reach out to the Connect Support Team at [email protected]

Meta

Tyro Tap to Pay SDK (iOS)

Disclaimer

Tap to Pay on iPhone requires the latest version of iOS. Update to the latest version by going to Settings > General > Software Update. Tap Download and Install. Some contactless cards may not be accepted. Transaction limits may apply. The Contactless Symbol is a trademark owned by and used with permission of EMVCo, LLC. Tap to Pay on iPhone is not available in all markets. View Tap to Pay on iPhone countries and regions.