Tap to Pay on iPhone beta

Integrate MoovKit

Moov's SDK to integrate Tap to Pay on iPhone functionality is available for download and you can find more details in the documentation.

Add MoovKit as a package dependency to your project via via Swift Package Manager.

1

https://github.com/moovfinancial/moov-ios

Within the project you'll also need to embed the framework and link binary with libraries. See the MoovKit documentation for complete details.

And finally, add MoovKit to your project.

1

import MoovKit

Request entitlement from Apple

Your application must request an entitlement from Apple for Tap to Pay on iPhone. You can request from your Apple Developer Account.

After receiving the entitlement, you should configure the entitlement in your project. View the full instructions on developer.apple.com.

1
2
3
4
5
6
7
8

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>com.apple.developer.proximity-reader.payment.acceptance</key>
    <true/>
</dict>
</plist>

Review Apple's guidelines

Implement terminal configuration provider

Implement a terminal configuration provider to initialize MoovKit. For production use, fetch the configuration from your backend. Below is a sample implementation, assuming PartnerClient is implemented to interact with your backend API:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

import Foundation
import PartnerClient
import os

class TerminalConfigProvider: TerminalConfigurationProvider {
  let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "main")
  
  var terminalConfiguration: String {
    get async throws {
        return try await fetch(terminalApplicationID: UUID(uuidString: "7922ce07-daf3-48f2-aab3-ed878c76a1a3")!)
    }
  }

  let partnerClient: PartnerClient
  let partnerAccountID: UUID
  let merchantAccountID: UUID

  public init(partnerClient: PartnerClient, partnerAccountID: UUID, merchantAccountID: UUID) {
    self.partnerClient = partnerClient
    self.partnerAccountID = partnerAccountID
    self.merchantAccountID = merchantAccountID
  }

  func fetch(terminalApplicationID: UUID) async throws -> String {
    do {            
      let terminalConfig = try await partnerClient.getTerminalConfiguration(
        accountID: merchantAccountID,
        terminalApplicationID: terminalApplicationID
      )
      return terminalConfig.configuration
    } catch {
      logger.error("\(error)")
      throw error
    }
  }
}

View the SDK documentation for more details and context.

Register application

Applications must be registered with Moov to be authorized to use MoovKit. The process for application registration is as follows:

1. Create a TerminalApplication via the create terminal application endpoint

1
2
3
4
5

curl -X POST "/terminal-applications" \
  -H "Authorization: Bearer {token}" \
  --data '{
    "platform": "android"
  }'\

2. The application will move from pending to enabled once approved. You can subscribe to the terminalAppRegistration.updated webhook to be notified of the status updates

3. Once the application is enabled, you must link the app's TerminalApplication to a merchant account via the link terminal application endpoint

1
2
3
4
5

curl -X POST "/accounts/{accountID}/terminal-applications" \
  -H "Authorization: Bearer {token}" \
  --data '{
    "terminalApplicationID": "UUID"
  }'\

Terms & condition acceptance

Merchants need to accept Apple's terms and conditions - once for each merchant identifier. Once the terms and conditions are accepted, any device using the same merchant identifier can use Tap to Pay on iPhone without accepting the terms and conditions again. The additional devices don’t need to use the same Apple account, or be signed in to Apple.

For the best user experience, it’s recommended to present the terms and conditions before the checkout experience.

View Apple's documentation for more information on terms and conditions.

Create transfer

1. Once terms and conditions have been accepted, initialize the reader hardware.

1
2
3
4
5
6

do {
  let identifier = try await moov.initReader()
  logger.debug("identifier \\(String(describing: identifier))")
} catch {
  logger.error("Failed to fetch identifier")
}

2. Create a payment session by calling createSession(invalidateTerminalConfiguration:) as early as possible to configure the device.

There are two main paths to accept EMV payments:

• Directly create a transfer from the SDK
• Create an authorization via the SDK and create the transfer separately

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

do {
  let accessToken = // source from Moov backend
  let paymentMethodId = // source from Moov backend
  let transfer = try await moov.createTapTransfer(
    for: amount, 
    currencyCode: CurrencyCode.USD, 
    transactionType: .purchase, 
    destinationPaymentMethodId: paymentMethodId, 
    customerAccountId: nil, 
    description: nil, 
    using: accessToken
	)
} catch {
	logger.error("Card read error: \(error)")
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

do {
  let amt = Decimal(1.23)
  let authResponse = try await moov.createTapAuthorization(
    for: amount,
    currencyCode: CurrencyCode.USD,
    transactionType: .purchase,
    customerAccountID: UUID()
  )
    
// send authResponse.paymentToken to your backend to create a transfer using authorization as the source
} catch {
  logger.error("Card read error: \(error)")
}