Build on iOS

The Mobile Payments SDK offers developers a secure way to integrate the Square checkout flow into their mobile applications, and accept in-person payments with a Square Reader or Square Stand.

There are four steps required to take your first payment using the Mobile Payments SDK:

1. Install and configure the Mobile Payments SDK in your Xcode application
2. Authorize the Mobile Payments SDK
3. Pair a card reader
4. Take a payment

To build with the Mobile Payments SDK for iOS, the following must be true:

• You have a Square account enabled for payment processing. If you haven't enabled payment processing on your account (or you're not sure), visit squareup.com/activation.

• Your Square account is based in the United States. If you're developing from outside the United States, you can take test payments in the Square Sandbox, but can't take production payments.

• You have a Square Reader device to take payments in production (not required for Sandbox payments).

• You're using Xcode 15.1+.

• You've set your Xcode iOS deployment target to iOS 15+.

• You have a Square application ID. You can find your application ID on the Developer Console.

• Your application must request an OAuth access token to authorize Square sellers using your application to take payments.

• Your version of the Mobile Payments SDK adheres to the Square update policy. To limit risk to developers and their users, Square enforces an update policy requiring developers keep their version of the Mobile Payments SDK current.

• You're generally familiar with developing applications on iOS. If you're new to iOS development, you should visit the Apple Training Center before continuing.

The Mobile Payments SDK requires that each user grant access to their device's current location while using your application. This ensures that payments are taken in a Square-supported country and that each payment is associated with a specific seller location. At this time, the Mobile Payments SDK can only be used to take production payments in the United States. Bluetooth must be enabled to take payments with a contactless and chip reader and microphone access must be granted to take payments with a magstripe reader.

Include the following privacy key/value pairs in your application's Info.plist file:

The Mobile Payments SDK isn't compatible with custom devices from OEMs that violate Square's security rules or on devices that grant root access to the mobile device operating system code and kernel. These devices cannot connect to a contactless and chip reader.

The following additional considerations apply when trying to run the SDK on custom devices:

• The Mobile Payments SDK isn't supported for rooted or jailbroken devices.
• The Mobile Payments SDK cannot run on custom operating systems.
• Square prohibits using any software that provides the ability to record or capture screen data or that results in elevated privileges.
• Verify that your device is supported for Square readers.
• Supported OS versions should be the latest or as close to the latest as possible.
• Review Square's support window for the OS version and confirm support for the compilation target version and the runtime version: The compilation target currently supports iOS versions 15 and later.

Get started with the Mobile Payments SDK by configuring your iOS application and taking a test payment in the Square Sandbox.

Install the Mobile Payments SDK with Swift Package Manager by following these steps in your Xcode project:

1. Choose File, and then choose Add Package Dependencies.
2. Enter the repository URL: https://github.com/square/mobile-payments-sdk-ios.
3. Choose the Exact Version dependency rule and specify the version as 2.0.0-beta3.
4. Ensure the SquareMobilePaymentsSDK` product is added to your target.
5. Optionally, you can also add the MockReaderUI product to your target to simulate a physical reader when one isn't present in a Sandbox environment.

Install the Mobile Payments SDK with Cocoapods by adding the following to your Podfile:

use_frameworks!

pod "SquareMobilePaymentsSDK", "~> 2.0.0-beta3"

# To use a simulated reader device to take sandbox payments, add the optional MockReaderUI:
pod "MockReaderUI", "~> 2.0.0-beta3", configurations: ['Debug']

1. On the Build Phases tab for your application target, choose the + button (at the top left of the pane).

2. Choose New Run Script Phase. The new run script phase should be the last build phase.

3. Paste the following into the editor panel of the new run script:

   FRAMEWORKS="${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}"
   "${FRAMEWORKS}/SquareMobilePaymentsSDK.framework/setup"

   Important

   Ensure the new run script phase is the last build phase. Otherwise, the build fails.

In order for the run script to execute correctly, your application must disable user script sandboxing.

1. On the Build Settings tab for your application target, find the Build Options section.
2. This section contains a setting called "User Script Sandboxing". Update the value of this setting to No for all build configurations.

Before taking a payment or attempting any other operation with the Mobile Payments SDK, you must initialize it using the initialize() method and your Square application ID in your AppDelegate's didFinishLaunchingWithOptions method.

To get your application ID, sign in to the Developer Console and choose your application. If you don't have an application yet, see Get Started for steps to create a Square application.

Your application opens to the Credentials page. This page contains the Square application ID used to initialize the Mobile Payments SDK.

import UIKit
import SquareMobilePaymentsSDK

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, 
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {

        MobilePaymentsSDK.initialize(
            applicationLaunchOptions: launchOptions, 
            squareApplicationID: "<#your_square_application_id#>"
        )

        return true
    }
}

The AuthorizationManager handles authorization for the Mobile Payments SDK. Call the authorize() method with an OAuth access token and location ID. If you're testing your application in the Square Sandbox, you can use your personal access token and location ID from the Sandbox tab in your Developer Console.

When authorization completes, the AuthorizeCompletionHandler provides the result of the authorization, including any errors.

import SquareMobilePaymentsSDK

class <#YourViewController#>: UIViewController {
    func authorizeMobilePaymentsSDK(accessToken: String, locationID: String) {
        guard MobilePaymentsSDK.shared.authorizationManager.state == .notAuthorized else {
            return
        }

        MobilePaymentsSDK.shared.authorizationManager.authorize(
           accessToken: accessToken,
            locationID: locationID) { error in
                if let authError = error {
                    // Handle auth error
                    print("error: \(authError.localizedDescription)")
                    return
                }

                print("Square Mobile Payments SDK successfully authorized.")
        }
    }
}

The Mobile Payments SDK requires the user to grant access to the device’s current location while using your application. This permission is required for payment, so you should only start a payment if you’ve determined that location access has been granted.

import CoreLocation

class <#YourViewController#>: UIViewController {
    private lazy var locationManager = CLLocationManager()

    // Call this in your app's lifecycle
    func requestLocationPermission() {
        switch CLLocationManager.authorizationStatus() {
        case .notDetermined:
            locationManager.requestWhenInUseAuthorization()
        case .restricted, .denied:
            print("Show UI directing the user to the iOS Settings app")
        case .authorizedAlways, .authorizedWhenInUse:
            print("Location services have already been authorized.")
        @unknown default:
            fatalError()
        }
    }
}

To use contactless readers (Square Reader for contactless and chip or Square Stand) with the SDK, you must request Bluetooth permission from users of your application. Use a method similar to the requestBluetoothPermissions() method below:

import CoreBluetooth

final class <#YourViewController#>: ViewController {
    private var centralManager: CBCentralManager?

    // Call this in your app's lifecycle
    func requestBluetoothPermissions() {
        guard CBManager.authorization == .notDetermined else {
            return
        }

        centralManager = CBCentralManager(
            delegate: self,
            queue: .main,
            options: nil
        )
    }
}

extension <#YourViewController#>: CBCentralManagerDelegate {
    func centralManagerDidUpdateState(_ central: CBCentralManager) {
        // Check state and prompt for permission if necessary
    }
}

Physical card readers aren't supported in the Square Sandbox. To take test payments, you must simulate a virtual reader with the Mock Reader UI.

The Mock Reader UI consists of a floating button that can be dragged anywhere on the screen and persists as you navigate between screens in your application. Instantiate the Mock Reader UI and show the button with try? self.mockReaderUI?.present().

import MockReaderUI

private lazy var mockReaderUI: MockReaderUI? = {
  do {
    return try MockReaderUI(for: MobilePaymentsSDK.shared)
  } catch {
    assertionFailure("Could not instantiate a mock reader UI: \(error.localizedDescription)")
  }

  return nil
}()

try? mockReaderUI?.present()

Click the following button to simulate connecting a magstripe reader or a contactless and chip reader to your device.

When mock readers have been connected and you begin a payment, click the button again to test your application's payment flow and simulate a swiped, inserted, or tapped card with the mock reader. Choose Payment details to select different card brands and payment behaviors (approved or declined) for testing purposes. To hide the mock reader UI in your application, call self.mockReaderUI?.dismiss().

To pair physical readers for production payments, see Pair and Manage Card Readers.

The PaymentManager handles payments in the Mobile Payments SDK. Prior to starting a payment, you create PaymentParameters to represent details of an individual payment, and PromptParameters indicating how the payment prompts are presented to the buyer.

When setting up a payment, you must conform to the PaymentManagerDelegate to handle results and errors from a payment. If the payment completes successfully, a Payment object is returned, which can be accessed on the Sandbox Square Dashboard or with the Payments API. If the payment fails, the response contains a PaymentError.

Before beginning a payment, create a PaymentParameters object, which includes the payment amount, idempotency key, optional tip, application fee (if applicable), and the processing mode if you want to take payments while offline. For the complete list of payment parameter values and details, see the iOS technical reference.

Each payment must also have PromptParameters configured, consisting of a mode and additionalMethods available to buyers.

Square provides a payment prompt screen that displays a UI to buyers prompting them to swipe, insert, or tap their card, depending on the payment options available. To use this screen for your quickstart application, set the PromptParameters.mode to default.

If you create your own custom payment prompt UI by passing custom in the PromptParameters.mode, use the availableCardInputMethodsObserver to update your UI if the available card entry methods change (for example, if a magstripe reader is inserted or removed from the mobile device).

When you're ready to begin a payment, call PaymentManager.startPayment() with the PaymentParameters and PromptParameters you created for this payment.

import SquareMobilePaymentsSDK

class <#YourViewController#>: UIViewController {

    private var paymentHandle: PaymentHandle?

    func startPayment() {
        paymentHandle = MobilePaymentsSDK.shared.paymentManager.startPayment(
            makePaymentParameters(),
            promptParameters: PromptParameters(
                mode: .default,
                additionalMethods: .all
            ),
            from: self,
            delegate: self
        )
    }

    func makePaymentParameters() -> PaymentParameters {
        PaymentParameters(
            idempotencyKey: UUID().uuidString,
            amountMoney: Money(amount: 100, currency: .USD)
        )
    }
}

extension <#YourViewController#>: PaymentManagerDelegate {
    public func paymentManager(
        _ paymentManager: PaymentManager,
        didFinish payment: Payment
    ) {
        print("Payment Did Finish: \(payment)")
    }

    public func paymentManager(
        _ paymentManager: PaymentManager,
        didFail payment: Payment,
        withError error: Error
    ) {
        // Handle Payment Failed
        print("error: \(error.localizedDescription)")
    }

    public func paymentManager(
        _ paymentManager: PaymentManager,
        didCancel payment: Payment
    ) {
        // Handle Payment Canceled
    }
}

During each payment, Square takes control of the screen display to ensure that buyer information is handled securely and that the final confirmation of the payment is correctly shown to the buyer. While a payment is in progress, the UIViewController passed to startPayment must remain presented or pushed until your PaymentManagerDelegate receives a callback indicating the payment has completed, failed, or was canceled. After the payment starts, it can't be canceled by the developer.

If the payment completes successfully, a Payment object is returned to your payment callback. This payment can be accessed on the Square Dashboard or with the Payments API. If the payment fails, the response contains an error.

After installing the Mobile Payments SDK and testing your application with test payments in the Square Sandbox, learn more about configuring your application to take production payments:

• Authorize the Mobile Payments SDK
• Pair and Manage Card Readers
• Take a Payment