OloPaySDK

Getting Started

Useful Links:

Changelog

SDK Version List

The Olo Pay SDK enables easy PCI-compliant payment integration with the Olo Ordering API. At a high level, usage follows this paradigm:

Add the SDK .aar as a dependency in your app's gradle file

implementation files('/path/to/aar)

Add SDK dependencies to your app's gradle file (temporary requirement until Olo Pay is on Maven)

implementation "com.stripe:stripe-android:17.2.0"
implementation "androidx.core:core-ktx:1.6.0"
implementation "com.google.android.material:material:1.4.0"

Initialize the SDK on application startup

See the com.olo.olopay.bootstrap package
See the com.olo.olopay.api.OloPayApiInitializer class

Add a payment control to your app

See the com.olo.olopay.controls package
See the com.olo.olopay.googlepay.GooglePayContext class

Using the IPaymentMethodParams instance from the payment control, create an IPaymentMethod instance via OloPayAPI.createPaymentMethod()

See the com.olo.olopay.api package

Submit the IPaymentMethod data to the Basket Submit endpoint of Olo's Ordering API

Packages

com.olo.olopay.api

The Olo Pay API implementation, which is used for creating an IPaymentMethod instance from user-entered card details

com.olo.olopay.bootstrap

When the application starts, the Olo Pay SDK needs to be initialized by calling OloPayApiInitializer().setup(). Classes in this package can help with the initialization.

com.olo.olopay.controls

The Olo Pay SDK provides three controls for capturing card details from a user. They are PCI-compliant and can be added to your application layouts just like any standard View.

com.olo.olopay.controls.callbacks

Callbacks for responding to user input on the PCI-compliant credit card controls

com.olo.olopay.data

An assortment of data and enum classes used throughout the Olo Pay SDK

com.olo.olopay.exceptions

Exceptions that can be thrown while making Olo Pay API calls

com.olo.olopay.googlepay

Classes for adding Google Pay support to your app.