Apple Pay Configuration

Setting up your app for use with Apple Pay

PDF for offline use
Related Articles:
Related Samples:
Related APIs:
Related SDKs:

Let us know how you feel about this

Translation Quality


0/250

This guide explores setting up the Xamarin.iOS environment for use with Apple Pay to pay for physical goods, such as food, entertainment, and memberships via your app. It includes information on the required identifiers, certificates and entitlements.

This guide gives a brief introduction to the following topics:

Overview

Apple Pay was introduced alongside iOS 8, enabling users to pay for physical goods such as food, entertainment, and memberships via their iOS devices. It is available on iPhone 6 and iPhone 6 Plus, and can also be paired with the Apple Watch for in-store purchases. When used on an iPhone, it uses Touch ID as a way to confirm and authorize transactions to a user's credit or debit card.

Requirements

Apple Pay is only available within iOS 8 and above, and therefore requires a minimum of Xcode 6.

The following items are also required to integrate Apple Pay into your app:

  • Payment Processor Platform
  • Merchant Identifier
  • An Apple Pay certificate
  • Apple Pay entitlement

This document will look at these items in more detail.

Differences between Apple Pay and IAP

The primary difference between Apple Pay and In-App Purchasing (IAP), pertains to the products that they sell. Physical goods are sold via Apple Pay; food, accommodation and physical entertainment (such as cinema tickets) are all examples of this. In contrast, IAP sells virtual goods, such as premium or extra content, and subscriptions–think additional months of a streaming service, or extra lives in a game.

The frameworks used are also a key difference; PassKit is used for Apple Pay, while StoreKit provides the framework API for IAP.

With Apple Pay, Apple states that it “[Does] not charge users, merchants or developers to use Apple Pay for Payments”. In comparison, IAP has a 30% charge for each transaction. Moreover, with Apple Pay, the transaction does not go through Apple at all, instead, it goes through a Payment platform.

Using a Payment Processor Platform

One of the fundamental parts of Apple Pay is the processing of payments. While it is possible to do this yourself, it requires significant knowledge of cryptography - as detailed in Apple’s Payment Processing guide. Payment processing platforms, on the other hand, handle these operations for you, allowing you to concentrate on building your app.

Two options are currently available on the Xamarin Component Store:

Right-click on the Components node in your iOS project and select Get More Components... to add one of these providers to your app; then sign up on their website to configure your account.

Provisioning for Apple Pay

Configuring an app to use Apple Pay requires setup on the Apple Developer Portal and within your app. There are a number of steps that should be followed to successfully provision your app for Apple pay:

  1. Create a Merchant ID.
    • Follow the steps here
  2. Create an App ID with the Apply Pay capability and add the merchant to it.
    • Follow the steps here
  3. Generate a certificate for the Merchant ID.
    • Follow the steps here
  4. Generate a Provisioning Profile with the newly created App ID
    • Follow the steps here
  5. Add Apple Pay entitlements
    • Select the Apple pay entitlement as detailed here, or manually add the key/value pair to the file from here

iOS 10 Apple Pay Enhancements

Apple has made several enhancements to Apple Pay in iOS 10 that allow the user to make secure payments from websites and through interaction with Siri and Maps.

With iOS 10, several new APIs have been added that work with both iOS and watchOS to support dynamic payment networks and a new sandbox test environment.

Apple Pay Website Integration

New to iOS 10, the developer can incorporate Apple Pay directly into their websites using ApplePay JS. Users browsing the website with Safari in iOS or macOS can make payments with Apple Pay by validating the transaction on their iPhone or Apple Watch. For more information, please see Apple's ApplePay JP Framework Reference.

PassKit Framework Enhancements

In iOS 10, the PassKit framework has been expanded to support Apple Pay outside of UIKit and to allow card issuers to present their own cards from within their apps.

Supporting Apple Pay Outside of UIKit

By using PKPaymentAuthorizationController and PKPaymentAuthorixationControllerDelegate, an app can support the same functionality provided by PKPaymentAuthorizationViewController without using UIKit. While this new API is required for supporting Apple Pay on the Apple Watch (and in specific Intents as well), it is optional in other situations (such as existing apps). However, Apple suggests moving to the new API as soon as possible to provide broad Apple Pay support throughout all of the developer's apps with a single code base. For more information about Intents and Siri integration, please see our Introduction to SiriKit documentation.

Presenting Issuer Cards from within Apps

With iOS 10, new features have been added to the PassKit framework that allow card issuers to present their cards from within their own apps. The developer can add a PKPaymentButtonTypeInStore UIButton to the app's user interface that will display an Apple Pay button for a card.

The PresentPaymentPass method of the PKPassLibrary class can also be used to programmatically display the card.

New Payment Network Support

New to iOS 10, an app can automatically support a new payment network when it becomes available without the developer having to modify, recompile the app and resubmit it to the App Store.

The new AvailableNetworks method of the PKPaymentNetwork class allows an app to discover the networks available on the user's device at runtime. Additionally, the SupportedNetworks property has been expanded to take the payment provider's name as an argument. Using these methods, an app can automatically support any network that the payment provider supports.

For more information, please see our Apple Pay Configuration and Apple's Apple Pay Guide.

New Testing Environment

With iOS 10, Apple introduced a new testing environment that allows the developer to provision test payment cards directly on an iOS device. This new testing environment then returns encrypted test payment data to the app.

To enable the new testing environment, do the following:

  1. Create a new testing iCloud Account in iTunes Connect.
  2. Log into the iOS device with the new testing account.
  3. Set the desired region to test the app in.
  4. Use one of the test payment cards from the Apple Pay Guide to make payments.
⚠️

NOTE: By switching iCloud Accounts, the device will automatically switch to the new testing environment. However, Apple still requires the app to be tested with real cards in a production environment before submission to the iTunes App Store.

Summary

In this article, we explored the different items required to use Apple Pay within your app. We looked at how to create a Merchant ID, and how it is used within the Entitlements.plist, which needs to be modified manually.

Xamarin Workbook

If it's not already installed, install the Xamarin Workbooks app first. The workbook file should download automatically, but if it doesn't, just click to start the workbook download manually.