Welcome to the Olo Pay SDK

PCI compliance is your responsibility. The Olo Pay SDK enables 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

First Time Setup

1. Install Carthage
2. From a terminal navigate to the OloPaySDK folder and run ./carthage-update.sh
3. Drag the following frameworks from OloPaySDK/Carthage/Build to your Xcode project’s Frameworks folder
   • Stripe.xcframework
   • StripeCore.xcframework
   • StripeUICore.xcframework
   • Stripe3DS2.xcframework
   • StripeApplePay.xcframework
4. Drag OloPaySDK/OloPaySDK.xcodeproj to your Xcode project’s Frameworks folder
5. In your .xcodeproj configuration, do the following
   1. Create Production and Development targets for your project if you don’t have them already
   2. For both targets, do the following:
      1. In Build Phases > Dependencies, add the OloPaySDK Framework to both targets
      2. In Build Phases > Link Binary With Libraries
         1. Add OloPaySDK.framework
         2. Add all the Stripe frameworks listed above
      3. In Build Phases > Embed Frameworks, do the following:
         1. Add OloPaySDK.framework
         2. Add all the Stripe frameworks listed above
         3. Ensure Code Sign On Copy is selected for all frameworks

SDK Updates

1. From a terminal navigate to the OloPaySDK folder and run ./carthage-update.sh
2. Add any missing Stripe frameworks listed above

Getting Started

1. Initialize the SDK on application startup
   • Specify the environment in OPSetupParameters

   See

   See OloPayApiInitializer.setup(with:completion:)
2. Add a payment input control to your app

   See

   See OPPaymentCardDetailsView

   See

   See OPPaymentCardDetailsForm

   See

   See OPApplePayContext
3. Create a payment method
   • Each payment input control provides a way to get an instance of OPPaymentMethodParamsProtocol
   • Get an OPPaymentMethodProtocol instance by calling OloPayAPI.createPaymentMethod(with:completion:)
4. Submit the OPPaymentMethodProtocol data to the Basket Submit endpoint of Olo’s Ordering API