Welcome to the Olo Pay SDK

PCI compliance is your responsibility but the Olo Pay SDK simplifies your process of maintaining PCI compliance by doing the heavy lifting of processing sensitive credit card data for you. See below for details on adding the SDK to your project and integrating it into your app to submit payments to Olo’s Ordering API.

Useful Links

• Changelog
• SDK Version List

Setup

Use one of the following guides to add the Olo Pay SDK to your Xcode project

• Carthage Setup
• CocoaPods Setup
• Swift Package Manager Setup
• Manual Setup

Getting Started

The Olo Pay SDK helps with PCI compliance by creating a token to represent sensitive credit card data. The tokenized data is then used in your app to submit payments via Olo’s Ordering API. The Olo Pay SDK supports two different types of tokens: Payment Method and CVV Update tokens. Specific details about each token and how to use the SDK to generate them can be found below.

Payment Methods (new cards & digital wallets)

This approach is used for cards that have not previously been saved on file with Olo. This includes new credit cards and digital wallets. With this tokenization approach, an OPPaymentMethodProtocol is created that is then used to submit a basket with Olo’s Ordering API.

1. Initialize the SDK. It is recommended to initialize on application startup, but it can be initialized anywhere in your app that is convenient.

   See

   OloPayApiInitializer.setup(for:completion:)

   Note

   It is important to make sure the SDK is initialized prior to calling methods that generate payment methods

2. Choose how to create a payment method

   • Credit Card Input UI Control
     1. Add a payment input control to your app

        See

        OPPaymentCardDetailsView. This will display an input control that contains input fields for all credit card fields in a single one-line component. This control provides the most flexibility for styling and customization.

        See

        OPPaymentCardDetailsForm. This will display an input control that breaks out each field into a larger form. This control has fewer options for styling and customization.
     2. Get an OPPaymentMethodParamsProtocol instance

        See

        OPPaymentCardDetailsView.getPaymentMethodParams(...)

        See

        OPPaymentCardDetailsForm.getPaymentMethodParams(...)
     3. Generate an OPPaymentMethodProtocol instance

        See

        OloPayAPI.createPaymentMethod(...)
   • Digital Wallet (Apple Pay)
     1. Create an Apple Pay button using Apple’s PKPaymentButton class
     2. When the user clicks the button, present the Apple Pay sheet

        See

        OPApplePayLauncher.present(...)
     3. Retrieve the OPPaymentMethodProtocol created by OPApplePayLauncher

        See

        OPApplePayLauncherDelegate.paymentMethodCreated(...)

3. Submit the OPPaymentMethodProtocol data to the Basket Submit endpoint of Olo’s Ordering API

CVV Update Tokens (previously saved cards)

This approach is used for cards that have previously been saved on file with Olo, and you want to reverify the CVV of the saved card prior to submitting a basket and processing a payment. With this tokenization approach, an OPCvvUpdateToken is created that is then used to submit a basket with Olo’s Ordering API.

1. Initialize the SDK. It is recommended to initialize on application startup, but it can be initialized anywhere in your app that is convenient.

   See

   OloPayApiInitializer.setup(with:completion:)

   Note

   It is important to make sure the SDK is initialized prior to calling methods that generate payment methods

2. Add the CVV control to your app

   See

   OPPaymentCardCvvView. This will display an input field for entering a CVV value. It can be styled and customized to meet your needs.

3. Get an OPCvvTokenParamsProtocol instance

   See

   OPPaymentCardCvvView.getCvvTokenParams()

4. Generate an OPCvvUpdateTokenProtocol instance

   See

   OloPayAPI.createCvvUpdateToken(...)

5. Submit the OPCvvUpdateTokenProtocol data to the Basket Submit endpoint of Olo’s Ordering API