@olo/pay-react-native
Advanced tools
Olo Pay is an E-commerce payment solution designed to help restaurants grow, protect, and support their digital ordering and delivery business. Olo Pay is specifically designed for digital restaurant ordering to address the challenges and concerns that weʼve heard from thousands of merchants.
The Olo Pay React Native SDK allows partners to easily add PCI-compliant Apple Pay and Google Pay functionality to their checkout flow and seamlessly integrate with the Olo Ordering API. The SDK supports React Native's new architecture (Fabric)
Use of the plugin is subject to the terms of the Olo Pay SDK License.
For more information about integrating Olo Pay into your payment solutions, refer to our Olo Pay Dev Portal Documentation (Note: requires an Olo Developer account).
npx expo prebuild prior to installationRun the following command from a terminal in your app's root project directory
npm install @olo/pay-react-native
minSdkVersion must be set to 24 or higherIn your app's Podfile:
source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/ololabs/podspecs.git'
ios.deploymentTarget is set to at least 14.0Open a terminal, navigate to your app's iOS folder (usually <projectName>/ios), and run the following command:
pod install
Run the following command from a terminal in your app's root project directory
npm install @olo/pay-react-native@latest
Open a terminal, navigate to your app's iOS folder (usually <projectName>/ios), and run the following commands:
rm -rf Pods
rm Podfile.lock
pod update
Note: If you run into errors after updating, delete both your
Podsfolder andPodfile.lockfile and then runpod install.
In order to use the PaymentCardDetailsView or PaymentCardDetailsForm components you need to install and configure Material Components theme in your app.
app/build.gradle add the dependency with a specific versionimplementation 'com.google.android.material:material:<version>'
styles.xml file. You can use a full Material Components theme or a Bridge theme (which extends AppCompat):<!-- Option 1: Full Material Components theme (recommended) -->
<style name="Theme.MyApp" parent="Theme.MaterialComponents.DayNight">
<!-- ... -->
</style>
<!-- Option 2: Bridge theme (for apps migrating from AppCompat) -->
<style name="Theme.MyApp" parent="Theme.MaterialComponents.DayNight.Bridge">
<!-- ... -->
</style>
In your app's AppDelegate.mm (or AppDelegate.swift), register the Olo Pay components before the app finishes launching.
Objective-C (AppDelegate.mm):
Add the following import and function call:
// At the top of AppDelegate.mm
extern "C" void registerOloPayComponents(void);
// In application:didFinishLaunchingWithOptions: before [super application:...]
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
registerOloPayComponents();
// ... rest of your existing code
return [super application:application didFinishLaunchingWithOptions:launchOptions];
}
Swift (AppDelegate.swift):
Add a bridging header with the declaration, then call it:
// In your bridging header (e.g., YourApp-Bridging-Header.h)
void registerOloPayComponents(void);
// In AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
registerOloPayComponents()
// ... rest of your existing code
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
A basic high-level overview of the steps needed to integrate the React Native SDK into your hybrid app is as follows:
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 approach both card input components and digital wallets return a PaymentMethod instance that is then used to submit a basket with Olo's Ordering API. Specific details can be found below.
initialize(...)).createPaymentMethod() function on the component to get a PaymentMethod instanceDigitalWalletReadyEvent to indicate when digital wallet payments can be processed.createDigitalWalletPaymentMethod(...)).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. The PaymentCardCvvView component will provide a CvvUpdateToken instance that is then used to submit a basket with Olo's Ordering API. Specific details can be found below.
initialize(...)).createCvvUpdateToken() function on the component to get a CvvUpdateToken instanceWhen calling functions on the Olo Pay React Native SDK, there is a chance that the call will fail with the promise being rejected. When this happens
the returned error object will always contain code and message properties indicating why the method call was rejected.
For convenience, the SDK exports a OloErrorCode enum and a OloError type for
handling promise rejection errors.
try {
const paymentMethodData = await createDigitalWalletPaymentMethod({ amount: 2.34 }});
//Handle payment method data
} catch (error) {
let rejection = error as OloError;
if (rejection) {
switch(rejection.code) {
case OloErrorCode.missingParameter: {
// Handle missing parameter scenario
break;
}
case OloErrorCode.sdkUninitialized: {
// Handle sdk not initialized scenario
break;
}
}
} else {
// Some other error not related to a promise rejection
}
}
Events are used to send notifications regarding state changes that can't be completely handled by asynchronous method calls that return a promise. Details about each type of event can be found below.
You can subscribe to this event to know when digital wallets are ready to process payments. It can be referenced using the exported DigitalWalletReadyEvent constant or as a string with "digitalWalletReadyEvent". The event returns a DigitalWalletStatus object. Attempting to create a PaymentMethod via createDigitalWalletPaymentMethod when digital wallets are not in a ready state will result in errors.
This event is emitted whenever the readiness of digital wallets change. It can change as a result of calling certain methods on the SDK (e.g. initialize or updateDigitalWalletConfig) or due to changes in app state (e.g. app going in the background).
Important: This event can, and likely will, be emitted multiple times. It is recommended to keep this event listener active and update your UI accordingly whenever the app is displaying digital wallet UIs.
Example Code:
import { OloPayEvents, DigitalWalletReadyEvent } from '@olo/pay-react-native';
let subscription = OloPayEvents.addListener(
DigitalWalletReadyEvent,
(event: DigitalWalletStatus) => {
// Handle event...
}
);
// Don't forget to unsubscribe when you no longer need to
// know if digital wallets are in a ready state
subscription.remove();
Components are used to display credit card input fields in an app. Credit card details are not accessible by the developer, helping reduce the effort needed to maintain PCI compliance. Details about each component can be found below.
The PaymentCardDetailsView component displays all credit card input details in a single input field and is the most compressed way to display a credit card input view. It is composed of a root <View> component with two direct children, the credit card input view and a <Text> view for displaying error messages. Each piece of the component can be individually styled via componentStyles, cardStyles, and errorStyles (See PaymentCardDetailsViewProps)
PaymentCardDetailsViewProps provides customization for the card component.
| Property | Description |
|---|---|
componentStyles | Options for styling the root <View> component |
errorStyles | Options for styling the error <Text> component. Default style is { minHeight: 20 } |
cardStyles | Options for styling credit card input portion of the component. (See PaymentCardDetailsViewStyles) |
viewProps | React Native view properties for the root <View> component |
customErrorMessages | Options for defining custom error messages in place of defaults (See CustomErrorMessages) |
postalCodeEnabled | Whether or not the postal code should be displayed |
disabled | Whether or not the component is disabled and cannot receive touch and input events |
displayErrorMessages | Whether or not the component should display error messages. Set to false if you have a custom mechanism for displaying error messages |
placeholders | Options for specifying placeholder text. (See PaymentCardDetailsPlaceholders) |
onCardChange(card: CardDetails) | Callback called when card input changes. (See CardDetails) |
onFocus() | Callback called when the component receives input focus |
onBlur() | Callback called when the component loses input focus |
onFocusField(field: CardField) | Callback called each time focus moves to a new card input field within the component. (See CardField) |
onPaymentMethodResult(result: PaymentMethodResult) | Callback called when payment method creation completes (See PaymentMethodResult) |
{
componentStyles?: StyleProp<ViewStyle>;
errorStyles?: StyleProp<TextStyle>;
cardStyles?: PaymentCardDetailsViewStyles;
viewProps?: ViewProps;
postalCodeEnabled?: boolean;
disabled?: boolean;
displayErrorMessages?: boolean;
placeholders?: PaymentCardDetailsPlaceholders;
onCardChange?(card: CardDetails): void;
onFocus?(): void;
onBlur?(): void;
onFocusField?(field: CardField): void;
customErrorMessages?: CustomErrorMessages;
onPaymentMethodResult?(result: PaymentMethodResult): void;
}
Important: Card field text and error message text have separate styling mechanisms. If the default error colors are changed, it is important to change both of them. An example is provided below:
<PaymentCardDetailsView cardStyles={{ errorTextColor: "#00ff00" }} errorStyles={{ color: "#00ff00" }} />
PaymentCardDetailsViewMethods defines the native methods that can be called on the PaymentCardDetailsView component. These methods can be accessed by passing a ref prop of this type into the component, and then calling them on the ref. See the PaymentCardDetailsView example code below for details.
focus()
focus(field?: CardField) => void
Puts focus on the PaymentCardDetailsView component and displays the keyboard. If a CardField is passed in, focus will attempt to be given to that field. If no field is passed in, it defaults to CardField.number.
blur()
blur() => void
Clears focus on the PaymentCardDetailsView component and hides the keyboard.
clear()
clear() => void
Clears all card details entered in the PaymentCardDetailsView component and moves focus to the CardField.number field.
createPaymentMethod()
createPaymentMethod() => void
Attempts to create a payment method based on the entered card details. Results are delivered via the onPaymentMethodResult callback:
result.paymentMethod contains a PaymentMethod instance and result.error is undefinedresult.error contains a OloError and result.paymentMethod is undefined. The error will contain one of the following codes:
import {
PaymentCardDetailsView,
PaymentCardDetailsViewMethods,
PaymentMethodResult,
} from '@olo/pay-react-native';
import { View, Button } from 'react-native';
import { useRef } from 'react';
export default function MyComponent() {
const cardRef = useRef<PaymentCardDetailsViewMethods>(null);
const handlePaymentMethodResult = (result: PaymentMethodResult) => {
if (result.error) {
// Handle the error
console.error(result.error.message);
return;
}
// Use the payment method to submit a basket using Olo's ordering API
const paymentMethod = result.paymentMethod!;
// Submit payment with paymentMethod.id
};
const createPaymentMethod = () => {
cardRef.current?.createPaymentMethod();
};
// Styling omitted for sake of example simplicity
return (
<View>
<PaymentCardDetailsView
displayErrorMessages={true}
ref={cardRef}
onPaymentMethodResult={handlePaymentMethodResult}
/>
<Button title="Submit Payment" onPress={createPaymentMethod} />
</View>
);
}
The PaymentCardDetailsForm component displays all credit card input details in a multi-line form and is the most visible way to display a credit card input view. It is composed of a root <View> component with a single nested child, the credit card input form. Each piece of the component can be individually styled via componentStyles and cardStyles (See PaymentCardDetailsFormProps)
PaymentCardDetailsFormProps provides additional properties defined in the following table
| Property | Description |
|---|---|
componentStyles | Options for styling the root <View> |
cardStyles | Options for styling credit card input portion of the component. (See PaymentCardDetailsFormStyles) |
disabled | Whether or not the component is disabled and cannot receive touch and input events |
onFormComplete() | Callback called when all card fields have been filled out. (See CardValidationStatus) |
viewProps | React Native view properties for the root <View> component |
placeholders | Options for specifying placeholder text. (See PaymentCardDetailsPlaceholders) |
onPaymentMethodResult(result: PaymentMethodResult) | Callback called when payment method creation completes (See PaymentMethodResult) |
{
cardStyles?: PaymentCardDetailsFormStyles;
componentStyles?: StyleProp<ViewStyle>;
disabled?: boolean;
onFormComplete?(cardValidationStatus: CardValidationStatus): void;
viewProps?: ViewProps;
placeholders?: PaymentCardDetailsPlaceholders;
onPaymentMethodResult?(result: PaymentMethodResult): void;
}
PaymentCardDetailsFormMethods defines the native methods that can be called on the PaymentCardDetailsForm component. These methods can be accessed by passing a ref prop of this type into the component, and then calling them on the ref. See the PaymentCardDetailsForm example code below for details.
focus()
focus(field?: CardField) => void
Puts focus on the PaymentCardDetailsForm component and displays the keyboard. If a CardField is passed in, focus will attempt to be given to that field. If no field is passed in, it defaults to CardField.number.
blur()
blur() => void
Clears focus on the PaymentCardDetailsForm component and hides the keyboard.
clear()
clear() => void
Clears all card details entered in the PaymentCardDetailsForm component and moves focus to the CardField.number field.
createPaymentMethod()
createPaymentMethod() => void
Attempts to create a payment method based on the entered card details. Results are delivered via the onPaymentMethodResult callback:
result.paymentMethod contains a PaymentMethod instance and result.error is undefinedresult.error contains a OloError and result.paymentMethod is undefined. The error will contain one of the following codes:
import {
PaymentCardDetailsForm,
PaymentCardDetailsFormMethods,
PaymentMethodResult,
} from "@olo/pay-react-native";
import { View, Button } from "react-native";
import { useRef } from "react";
export default function MyComponent() {
const cardRef = useRef<PaymentCardDetailsFormMethods>(null);
const handlePaymentMethodResult = (result: PaymentMethodResult) => {
if (result.error) {
// Handle the error
console.error(result.error.message);
return;
}
// Use the payment method to submit a basket using Olo's ordering API
const paymentMethod = result.paymentMethod!;
// Submit payment with paymentMethod.id
};
const createPaymentMethod = () => {
cardRef.current?.createPaymentMethod();
};
// Styling omitted for sake of example simplicity
return (
<View>
<PaymentCardDetailsForm
ref={cardRef}
onPaymentMethodResult={handlePaymentMethodResult}
/>
<Button
title="Submit Payment"
onPress={createPaymentMethod}
/>
</View>
);
};
The PaymentCardCvvView component displays a single input for a credit card's Card Verification Value (CVV). This is useful to reverify a credit card that has previously been saved with Olo. It is composed of a root <View> component with two nested children, the CVV code input and a <Text> component for displaying error messages. Each piece of the component can be individually styled via componentStyles and cvvStyles (See PaymentCardCvvViewProps)
| Property | Description |
|---|---|
componentStyles | Options for styling the root <View> component |
customErrorMessages | Option for defining custom error messages in place of defaults (See CustomFieldError) |
cvvStyles | Options for styling security code input portion of the component. (See PaymentCardCvvViewStyles) |
displayErrorMessages | Whether or not the component should display error messages. Set to false if you have a custom mechanism for displaying error messages |
errorStyles | Options for styling the error <Text> component. Default style is { minHeight: 20 } |
disabled | Whether or not the component is disabled and cannot receive touch and input events |
onBlur(cvvDetails: CvvDetails) | Callback called when the component loses input focus (See CvvDetails) |
onCvvChange(cvvDetails: CvvDetails) | Callback called when card input changes. (See CvvDetails) |
onFocus(cvvDetails: CvvDetails) | Callback called when the component receives input focus (See CvvDetails) |
placeholder | Placeholder text for the CVV input field |
viewProps | React Native view properties for the root <View> component |
onCvvTokenResult(result: CvvTokenResult) | Callback called when CVV update token creation completes (See CvvTokenResult) |
{
componentStyles?: StyleProp<ViewStyle>;
customErrorMessages?: CustomFieldError;
cvvStyles?: StyleProp<ViewStyle>;
displayErrorMessages?: boolean;
errorStyles?: StyleProp<ViewStyle>;
disabled?: boolean:
onBlur(details: CvvDetails)?: void;
onCvvChange(details: CvvDetails)?: void;
onFocus(details: CvvDetails)?: void;
placeholder?: string;
viewProps?: ViewProps;
onCvvTokenResult?(result: CvvTokenResult): void;
}
Important: CVV field text and error message text have separate styling mechanisms. If the default error colors are changed, it is important to change both of them. An example is provided below:
<PaymentCardCvvView cvvStyles={{ errorTextColor: "#00ff00" }} errorStyles={{ color: "#00ff00" }} />
PaymentCardCvvViewMethods defines the native methods that can be called on the PaymentCardCvvView component. These methods can be accessed by adding a ref prop of this type
into the component, and then calling them on the ref. See the PaymentCardCvvView example code below for details.
focus()
focus() => void
Puts focus on the PaymentCardCvvView component and displays the keyboard.
blur()
blur() => void
Clears focus on the PaymentCardCvvView component and hides the keyboard.
clear()
clear() => void
Clears all security code details entered in the PaymentCardCvvView component.
createCvvUpdateToken()
createCvvUpdateToken() => void
Attempts to create a CVV update token based on the entered security code details. Results are delivered via the onCvvTokenResult callback:
result.token contains a CvvUpdateToken instance and result.error is undefinedresult.error contains a OloError and result.token is undefined. The error will contain one of the following codes:
import {
PaymentCardCvvView,
PaymentCardCvvViewMethods,
CvvTokenResult,
} from '@olo/pay-react-native';
import { View, Button } from 'react-native';
import { useRef } from 'react';
export default function MyComponent() {
const cvvRef = useRef<PaymentCardCvvViewMethods>(null);
const handleCvvTokenResult = (result: CvvTokenResult) => {
if (result.error) {
// Handle the error
console.error(result.error.message);
return;
}
// Use the CVV update token for revalidating a stored credit card
const cvvToken = result.token!;
// Submit with cvvToken.id
};
const createCvvUpdateToken = () => {
cvvRef.current?.createCvvUpdateToken();
};
// Styling omitted for sake of example simplicity
return (
<View>
<PaymentCardCvvView
displayErrorMessages={true}
ref={cvvRef}
onCvvTokenResult={handleCvvTokenResult}
/>
<Button title="Submit CVV" onPress={createCvvUpdateToken} />
</View>
);
}
A button that renders a native Apple Pay button on iOS and a native Google Pay button on Android.
| Property | Description |
|---|---|
applePayConfig | Options for customizing the button for Apple Pay on iOS (See ApplePayButtonConfig) |
googlePayConfig | Options for customizing the button for Google Pay on Android (See GooglePayButtonConfig) |
styles | Options for styling the button. Default styles provide a minimum height of 40 on Android and 30 on iOS |
disabled | Whether or not the component is disabled and cannot receive touch events |
onPress() | Callback called when the button is pressed |
{
applePayConfig?: ApplePayButtonConfig;
googlePayConfig?: GooglePayButtonConfig;
disabled?: boolean;
onPress(): void;
styles?: StyleProp<ViewStyle>;
}
import {
ApplePayButtonStyle,
ApplePayButtonType,
DigitalWalletButton,
GooglePayButtonTheme,
GooglePayButtonType,
OloPaySDK
} from '@olo/pay-react-native';
export default function MyComponent() {
const createDigitalWalletPaymentMethod = async () => {
try {
let result = await OloPaySDK.createDigitalWalletPaymentMethod();
// Use result.paymentMethod method to submit a basket using Olo's ordering API
// or result.error to handle additional error scenarios
} catch (error) {
// Handle the promise rejection
}
};
// Styling omitted for sake of example simplicity
return (
<DigitalWalletButton
onPress={createDigitalWalletPaymentMethod}
googlePayConfig={{
theme: GooglePayButtonTheme.dark,
type: GooglePayButtonType.checkout,
cornerRadius: 8,
}}
applePayConfig={{
style: ApplePayButtonStyle.black,
type: ApplePayButtonType.checkout,
cornerRadius: 8,
}}
/>
);
}
Native SDK methods can be called on the imported OloPaySDK object. This module is responsible for initializing the Olo Pay SDK and processing digital wallet payments.
import { OloPaySDK } from '@olo/pay-react-native';
initialize(...)updateDigitalWalletConfig(...)createDigitalWalletPaymentMethod(...)isInitialized()isDigitalWalletInitialized()isDigitalWalletReady()initialize(productionEnvironment: boolean, digitalWalletConfig?: DigitalWalletConfig | undefined) => Promise<void>
Initialize the Olo Pay SDK and, optionally, configure and initialize digital wallets. The SDK must be initialized prior to calling other methods. Calling this method will ensure that the Olo Pay SDK is initialized. If a DigitalWalletConfig is provided, when digital wallets become ready, a DigitalWalletReadyEvent will be emitted. If digital wallets are not configured and initialized here, this can be done later by calling updateDigitalWalletConfig.
Important: The Olo Pay SDK is guaranteed to be initialized even if the promise is rejected. Promise rejections will only occur due to an error while initializing digital wallets, which happens after successful SDK initialization.
If the promise is rejected, the code property of the returned error object will be one of:
| Param | Type | Description |
|---|---|---|
productionEnvironment | boolean | true to use the production environment, false for the test environment |
digitalWalletConfig | DigitalWalletConfig | Initialization options for digital wallets |
updateDigitalWalletConfig(digitalWalletConfig: DigitalWalletConfig) => Promise<void>
Update the configuration settings for digital wallets.
This can be used to change configuration parameters for digital wallets. Calling this method will
immediately invalidate digital wallet readiness and will cause a DigitalWalletReadyEvent
to be emitted with a value of false. Once the new configuration is ready to be used,
the DigitalWalletReadyEvent will be triggered again with a value of true.
Note: This method can also be used to initialize digital wallets if they were not initialized as part of SDK initialization (see initialize).
If the promise is rejected, the code property of the returned error object will be one of:
| Param | Type | Description |
|---|---|---|
digitalWalletConfig | DigitalWalletConfig | The new configuration settings for digital wallets. See DigitalWalletConfig for more details. |
createDigitalWalletPaymentMethod(options: DigitalWalletPaymentRequestOptions) => Promise<DigitalWalletPaymentMethodResult>
Launch the digital wallet flow and generate a payment method to be used with Olo's Ordering API.
If the promise is rejected, the code property of the returned error object will be one of:
try {
const { paymentMethod } = await createDigitalWalletPaymentMethod({ amount: 5.00 });
if (paymentMethod === undefined) {
// User canceled the digital wallet flow
} else {
// Send paymentMethod to Olo's Ordering API
}
} catch (error) {
// Handle error
}
| Param | Type | Description |
|---|---|---|
options | DigitalWalletPaymentRequestOptions | Options for processing a digital wallet payment. |
Returns: Promise<DigitalWalletPaymentMethodResult>
isInitialized() => Promise<InitializationStatus>
Check if the Olo Pay SDK has been initialized
Returns: Promise<InitializationStatus>
isDigitalWalletInitialized() => Promise<InitializationStatus>
Check if digital wallets have been initialized. On iOS, digital wallets are initialized when the SDK is initialized, so this method
will behave the same as isInitialized(). On Android, a separate call to initializeGooglePay() is required to initialize digital wallets.
Returns: Promise<InitializationStatus>
isDigitalWalletReady() => Promise<DigitalWalletStatus>
Check if digital wallets are ready to be used. Events are emitted whenever the digital wallet status changes, so listenting to that event can be used instead of calling this method, if desired.
Returns: Promise<DigitalWalletStatus>
Options for intializing digital wallets
| Property | Description | Default |
|---|---|---|
countryCode | A two character country code for the vendor that will be processing the payment | 'US' |
currencyCode | Currency code to be used for transactions | CurrencyCode</a>.usd |
companyLabel | The company display name | - |
emailRequired | Whether an email will be collected and returned when processing transactions | false |
fullNameRequired | Whether a full name will be collected and returned when processing transactions | false |
fullBillingAddressRequired | Whether a full billing address will be collected and returned when processing transactions | false |
phoneNumberRequired | Whether a phone number will be collected and returned when processing transactions | false |
initializeApplePay | Whether Apple Pay should be initialized. | - |
initializeGooglePay | Whether Google Pay should be initialized. | - |
applePayConfig | Configuration options for initializing Apple Pay. Required if initializeApplePay is true | - |
googlePayConfig | Configuration options for initializing Google Pay. Required if initializeGooglePay is true | - |
Note: If Apple Pay or Google Pay were previously initialized and the respective initialize property (initializeApplePay or initializeGooglePay) is set to false, this will not uninitialize digital wallets and will result in a no-op.
{ companyLabel: string; countryCode?: string; currencyCode?: CurrencyCode; emailRequired?: boolean; phoneNumberRequired?: boolean; fullNameRequired?: boolean; fullBillingAddressRequired?: boolean; initializeApplePay: boolean; initializeGooglePay: boolean; applePayConfig?: ApplePayConfig; googlePayConfig?: GooglePayConfig; }
Type alias representing currency codes supported by Olo Pay.
'USD' | 'CAD'
Options for initializing Apple Pay
| Property | Description | Default |
|---|---|---|
fullPhoneticNameRequired | Whether a full phonetic name will be collected and returned when processing transactions | false |
merchantId | The merchant id registered with Apple for Apple Pay | - |
{ fullPhoneticNameRequired?: boolean; merchantId: string; }
Options for intializing Google Pay
| Property | Description | Default |
|---|---|---|
productionEnvironment | Whether Google Pay will use the production environment | true |
existingPaymentMethodRequired | Whether an existing saved payment method is required for Google Pay to be considered ready | false |
currencyMultiplier | Multiplier to convert the amount to the currency's smallest unit (e.g. $2.34 * 100 = 234 cents) | 100 |
{ productionEnvironment?: boolean; existingPaymentMethodRequired?: boolean; currencyMultiplier?: number; }
Type alias representing a digital wallet payment method result.
| Property | Description |
|---|---|
paymentMethod | The payment method generated by the digital wallet flow, or undefined if the user canceled the flow |
{ paymentMethod?: PaymentMethod; }
Payment method used for submitting payments to Olo's Ordering API
| Property | Description |
|---|---|
id | The payment method id. This should be set to the token field when submitting a basket |
last4 | The last four digits of the card |
cardType | The issuer of the card |
expMonth | Two-digit number representing the card's expiration month |
expYear | Four-digit number representing the card's expiration year |
postalCode | Zip or postal code. Will always have the same value as billingAddress.postalCode |
countryCode | Two character country code. Will always have the same value as billingAddress.countryCode |
isDigitalWallet | true if this payment method was created by digital wallets (e.g. Apple Pay or Google Pay), false otherwise |
productionEnvironment | true if this payment method was created in the production environment, false otherwise |
email | The email address associated with the transaction, or an empty string if unavailable. Only provided for digital wallet payment methods (see isDigitalWallet) |
digitalWalletCardDescription | The description of the card, as provided by Apple or Google. Only provided for digital wallet payment methods (see isDigitalWallet) |
billingAddress | The billing address associated with the transaction. The country code and postal code fields will always have a non-empty value. Other fields will only have non-empty values for digital wallet payment methods (see isDigitalWallet) |
fullName | The full name associated with the transaction. Will only have a non-empty value for digital wallet payment methods (see isDigitalWallet) |
fullPhoneticName | The full phonetic name associated with the transaction. Will only have a non-empty value for digital wallet payment methods (see isDigitalWallet) (iOS only) |
{ id: string; last4: string; cardType: CardType; expMonth: number; expYear: number; postalCode: string; countryCode: string; isDigitalWallet: boolean; productionEnvironment: boolean; email: string; digitalWalletCardDescription: string; billingAddress: Address; fullName: string; fullPhoneticName: string; phoneNumber: string; }
Represents an address. Currently only used for digital wallets, if billing address details are requested to be returned in the generated digital wallet payment method.
| Property | Description |
|---|---|
address1 | The first line of the address |
address2 | The second line of the address, or an empty string |
address3 | The third line of the address, or an empty string |
postalCode | The postal or zip code |
countryCode | The two digit ISO country code |
administrativeArea | A country subdivision, such as a state or province |
{ address1: string; address2: string; address3: string; locality: string; postalCode: string; countryCode: string; administrativeArea: string; }
Type alias representing options for a digital wallet payment method request
GooglePayPaymentRequestOptions | ApplePayPaymentRequestOptions
Options for requesting a payment method via Google Pay
| Property | Description | Default |
|---|---|---|
amount | The amount to be charged | - |
checkoutStatus | The checkout status to be used for the transaction | FinalImmediatePurchase |
totalPriceLabel | A custom value to override the default total price label in the Google Pay sheet | - |
lineItems | A list of line items to be displayed in the digital wallet payment sheet | - |
validateLineItems | Whether or not to validate the line items. If true, createDigitalWalletPaymentMethod will throw an exception if the sum of the line items does not equal the total amount passed in. If no line items are provided, this parameter is ignored. | true |
{ amount: number; checkoutStatus?: GooglePayCheckoutStatus; totalPriceLabel?: string; lineItems?: LineItem[]; validateLineItems?: boolean; }
Represents a line item in a digital wallet transaction
| Property | Description |
|---|---|
label | The label of the line item |
amount | The amount of the line item |
type | Enum representing the type of a line item in a digital wallet transaction |
status | Enum representing the status of a line item. If not provided, default value is LineItemStatus.final |
{ label: string; amount: number; type: LineItemType; status?: LineItemStatus; }
Options for requesting a payment method via Apple Pay
| Property | Description | Default |
|---|---|---|
amount | The amount to be charged | - |
lineItems | A list of line items to be displayed in the digital wallet payment sheet | - |
validateLineItems | Whether or not to validate the line items. If true, createDigitalWalletPaymentMethod will throw an exception if the sum of the line items does not equal the total amount passed in. If no line items are provided, this parameter is ignored. | true |
{ amount: number; lineItems?: LineItem[]; validateLineItems?: boolean; }
Represents the status for SDK initialization
| Property | Description |
|---|---|
isInitialized | true if the SDK is initialized, false otherwise |
{ isInitialized: boolean; }
Represents the status of digital wallets.
| Property | Description |
|---|---|
isReady | true if digital wallets are ready to be used, false otherwise |
{ isReady: boolean; }
| Members | Value | Description |
|---|---|---|
visa | 'Visa' | Visa credit card type. Pass the string value of this into the Olo Ordering API when submitting orders |
amex | 'Amex' | American Express credit card type. Pass the string value of this into the Olo Ordering API when submitting orders |
mastercard | 'Mastercard' | Mastercard credit card type. Pass the string value of this into the Olo Ordering API when submitting orders |
discover | 'Discover' | Discover credit card type. Pass the string value of this into the Olo Ordering API when submitting orders |
unsupported | 'Unsupported' | Unsupported credit card type. Passing this to the Olo Ordering API will result in an error |
unknown | 'Unknown' | Unknown credit card type. Passing this to the Olo Ordering API will result in an error |
| Members | Value | Description |
|---|---|---|
estimatedDefault | 'EstimatedDefault' | Represents an estimated price (meaning it's not final and could change) and the default checkout option. The confirmation button will display "Continue". |
finalDefault | 'FinalDefault' | Represents the final price of the transaction and the default checkout option. The confirmation button will display "Continue". |
finalImmediatePurchase | 'FinalImmediatePurchase' | Represents the final price of the transaction and the immediate checkout option. The confirmation button will display "Pay Now". |
| Members | Value | Description |
|---|---|---|
subtotal | 'Subtotal' | Represents a subtotal line item in a digital wallet transaction |
lineItem | 'LineItem' | Represents a line item in a digital wallet transaction |
tax | 'Tax' | Represents a tax line item in a digital wallet transaction |
| Members | Value | Description |
|---|---|---|
final | 'Final' | Indicates that the price is final and has no variance |
pending | 'Pending' | Indicates that the price is pending and may change. On iOS this will cause the amount to appear as an elipsis ("...") |
| Members | Value | Description |
|---|---|---|
apiError | 'ApiError' | A general-purpose API error occurred |
applePayEmptyMerchantId | 'ApplePayEmptyMerchantId' | The merchantId was empty when initializing Apple Pay (iOS Only) |
applePayError | 'ApplePayError' | There was an error with Apple Pay (iOS Only) |
applePayTimeout | 'ApplePayTimeout' | A timeout occurred while attempting to process an Apple Pay transaction (iOS Only) |
applePayUnsupported | 'ApplePayUnsupported' | The device doesn't support Apple Pay (iOS Only) |
authenticationError | 'AuthenticationError' | An authentication issue occurred with the server |
cancellationError | 'CancellationError' | The operation was cancelled by the server |
cardDeclined | 'CardDeclined' | The card was declined |
connectionError | 'ConnectionError' | An issue occurred connecting to the server |
digitalWalletNotReady | 'DigitalWalletNotReady' | Digital wallets were not ready when attempting an action |
digitalWalletUninitialized | 'DigitalWalletUninitialized' | Digital wallets were uninitialized when attempting an action |
emptyCompanyLabel | 'EmptyCompanyLabel' | The value for the company label was empty |
expiredCard | 'ExpiredCard' | The card is expired |
generalError | 'GeneralError' | A general-purpose error occurred |
googlePayDeveloperError | 'GooglePayDeveloperError' | A developer error occurred, usually due to malformed configuration (Android Only) |
googlePayInternalError | 'GooglePayInternalError' | An internal Google error occurred (Android Only) |
googlePayInvalidSetup | 'GooglePayInvalidSetup' | Missing com.google.android.gms.wallet.api.enabled in AndroidManifest (Android Only) |
googlePayNetworkError | 'GooglePayNetworkError' | A network error occurred with Google's servers (Android Only) |
invalidCardDetails | 'InvalidCardDetails' | The card details are invalid |
invalidCountryCode | 'InvalidCountryCode' | The country code is not supported by Olo Pay (US or Canada) |
invalidCVV | 'InvalidCVV' | The card security code is invalid or incomplete |
invalidExpiration | 'InvalidExpiration' | The card's expiration date is invalid |
invalidNumber | 'InvalidNumber' | The card's number is invalid |
invalidParameter | 'InvalidParameter' | Promise rejected due to an invalid parameter |
invalidPostalCode | 'InvalidPostalCode' | The card's zip code is invalid or incorrect |
invalidRequest | 'InvalidRequest' | A request to servers has invalid parameters |
lineItemsTotalMismatch | 'LineItemsTotalMismatch' | The amount total did not match the sum of the line items |
missingParameter | 'MissingParameter' | A required parameter is missing |
processingError | 'ProcessingError' | An error occurred while processing the card info |
sdkUninitialized | 'SdkUninitialized' | The SDK isn't initialized yet |
unexpectedError | 'UnexpectedError' | An unexpected error occurred |
unknownCard | 'UnknownCard' | An unknown or unaccounted-for card error occurred |
viewNotFound | 'ViewNotFound' | The native view associated with the component could not be found |
Represents the different input fields of the PaymentCardDetailsView and PaymentCardDetailsForm components
| Property | Value | Description |
|---|---|---|
number | 'number' | Credit card number field |
expiration | 'expiration' | Credit card expiration field |
cvv | 'cvv' | Credit card security code field |
postalCode | 'postalCode' | Credit card postal code field |
Options for determining the weight of the font.
| Property | Description |
|---|---|
ultraLight | Ultra light font weight. Corresponds to a value of 100 |
thin | Thin font weight. Corresponds to a value of 200 |
light | Light font weight. Corresponds to a value of 300 |
regular | Regular font weight. This is the default in most cases. Corresponds to a value of 400 |
medium | Medium font weight. Corresponds to a value of 500 |
semiBold | Semi Bold font weight. Corresponds to a value of 600 |
bold | Bold font weight. Corresponds to a value of 700 |
extraBold | Extra bold font weight. Corresponds to a value of 800 |
black | Heaviest font weight. Corresponds to a value of 900 |
Options representing different visual styles available for Apple Pay when used with a
DigitalWalletButton. Values map directly to Apple's
PKPaymentButtonStyle.
Some values are only available on specific versions of iOS. If an unsupported value is used, it will default to
black
| Property | Limitations | Description |
|---|---|---|
automatic | iOS 14+ | A button that automatically switches between light mode and dark mode |
black | A black button with white lettering | |
white | A white button with black lettering | |
whiteOutline | A white button with black lettering and a black outline |
Options representing different types of Apple Pay buttons that can be displayed with a
DigitalWalletButton. Values map directly to Apple's
PKPaymentButtonType.
Some values are only available on specific versions of iOS. If an unsupported value is used, it will default to
checkout
| Property | Limitations | Description |
|---|---|---|
addMoney | iOS 14+ | A button that uses the phrase "Add Money with" in conjunction with the Apple Pay logo |
book | A button that uses the phrase "Book with" in conjunction with the Apple Pay logo | |
buy | A button that uses the phrase "Buy with" in conjunction with the Apple Pay logo | |
checkout | A button that uses the phrase "Checkout with" in conjunction with the Apple Pay logo | |
continue | iOS 15+ | A button that uses the phrase "Continue with" in conjunction with the Apple Pay logo |
contribute | iOS 14+ | A button that uses the phrase "Contribute with" in conjunction with the Apple Pay logo |
donate | A button that uses the phrase "Donate with" in conjunction with the Apple Pay logo | |
inStore | A button that uses the phrase "Pay with" in conjunction with the Apple Pay logo | |
order | iOS 14+ | A button that uses the phrase "Order with" in conjunction with the Apple Pay logo |
plain | A button with the Apple Pay logo only | |
pay | A button that uses the phrase "Pay with" in conjunction with the Apple Pay logo. Equivalent to inStore | |
reload | iOS 14+ | A button that uses the phrase "Reload with" in conjunction with the Apple Pay logo |
rent | iOS 14+ | A button that uses the phrase "Rent with" in conjunction with the Apple Pay logo |
setUp | A button that uses the phrase "Set up with" in conjunction with the Apple Pay logo | |
subscribe | A button that uses the phrase "Subscribe with" in conjunction with the Apple Pay logo | |
support | iOS 14+ | A button that uses the phrase "Support with" in conjunction with the Apple Pay logo |
tip | iOS 14+ | A button that uses the phrase "Tip with" in conjunction with the Apple Pay logo |
topUp | iOS 14+ | A button that uses the phrase "Top up with" in conjunction with the Apple Pay logo |
Options representing different visual styles available for Apple Pay when used with a
DigitalWalletButton. Values map directly to Google's
ButtonTheme
| Property | Description |
|---|---|
dark | A dark-themed button |
light | A light-themed button |
Options representing different types of Google Pay buttons that can be displayed with a
DigitalWalletButton. Values map directly to Google's
ButtonType
| Property | Description |
|---|---|
book | A button that uses the phrase "Book with" in conjunction with the Google Pay logo |
buy | A button that uses the phrase "Buy with" in conjunction with the Google Pay logo |
checkout | A button that uses the phrase "Checkout with" in conjunction with the Google Pay logo |
donate | A button that uses the phrase "Donate with" in conjunction with the Google Pay logo |
order | A button that uses the phrase "Order with" in conjunction with the Google Pay logo |
pay | A button that uses the phrase "Pay with" in conjunction with the Google Pay logo. |
plain | A button with the Google Pay logo only |
subscribe | A button that uses the phrase "Subscribe with" in conjunction with the Google Pay logo |
When a promise is rejected, the error object returned is guaranteed to have
these properties to understand what went wrong. There may be additional properties
on the object, but code and message will always be available.
| Property | Description |
|---|---|
code | The code to indicate why the promise was rejected |
message | A message providing more context about why the promise was rejected. e.g. If the code is missingParameter the message will indicate which parameter is missing |
Options for specifying placeholder values for each credit card input field
| Property | Description |
|---|---|
number | The placeholder value for the credit card number field |
expiration | The placeholder value for the credit card expiration field |
cvv | The placeholder value for the credit card cvv field |
postalCode | The placeholder value for the credit card postal code field |
{ number?: string; expiration?: string; cvv?: string; postalCode?: string }
Options for styling the PaymentCardDetailsView component. All colors should be specified in hex format.
| Property | Description |
|---|---|
styles | React Native styles for this view. Default is { minHeight: 50 } |
borderWidth | The width of the card view's border |
borderColor | The color of the card view's border |
cornerRadius | The corner radius of the card view's border |
backgroundColor | The background color for the card view (Android Only: Requires API 27+) |
textColor | The text color for user-entered text (Android Only: Requires API 27+) |
fontSize | The font size for all text input |
fontFamily | The font family used for text |
placeholderColor | The color for placeholder text (Android Only: Requires API 27+) |
cursorColor | The color for the cursor (Android Only: Requires API 29+) |
errorTextColor | The color of the text inside the input fields if they are in an error state. Consider changing errorStyles.color when changing this property (Android Only: Requires API 27+) |
fontWeight | The stroke weight of the font in each of the fields. API 28+ can support all font weights. Lower API versions interpret a FontWeight of 700 or above as bold and below 700 as regular (Android Only) |
italic | Determins if the font inside the fields should be italic style (Android Only) |
textPaddingLeft | Padding (in pixels) for the left of the card input area. (Android Only) |
textPaddingRight | Padding (in pixels) for the right of the card input area. (Android Only) |
{
styles?: StyleProp<ViewStyle>;
borderWidth?: number;
borderColor?: string;
cornerRadius?: number;
backgroundColor?: string;
textColor?: string;
fontSize?: number;
fontFamily?: string;
placeholderColor?: string;
cursorColor?: string;
errorTextColor?: string;
fontWeight?: FontWeight;
italic?: boolean;
textPaddingLeft?: number;
textPaddingRight?: number;
}
Options for styling the PaymentCardDetailsForm component. All colors should be specified in hex format.
| Property | Description |
|---|---|
styles | React Native styles for this view. Default style in iOS is { minHeight: 190 } and in Android it is { minHeight: 310 } |
backgroundColor | The background color of the form |
cursorColor | The color of the cursor within the form |
borderWidth | The width of the card view's border (Android Only) |
borderColor | The color of the card view's border (Android Only) |
cornerRadius | The corner radius of the card view's border (Android Only) |
textColor | The text color for user-entered text (Android Only: Requires API 27+) |
fontSize | The font size for all text input (Android Only) |
fontFamily | The font family used for text (Android Only) |
placeholderColor | The color for placeholder text (Android Only: Requires API 27+) |
focusedPlaceholderColor | The color for placeholder text (Android Only: Requires API 27+) |
fontWeight | The stroke weight of the font in each of the fields. API 28+ can support all font weights. Lower API versions interpret a FontWeight of 700 or above as bold and below 700 as regular (Android Only) |
cardElevation | The depth of the form view's shadow (Android Only) |
dividerWidth | The width of the form view's border (Android Only) |
dividerColor | The color of the form view's dividers (Android Only) |
italic | Determins if the font inside the fields should be italic style (Android Only) |
textPaddingLeft | Padding (in pixels) for the left of the form input area. (Android Only) |
textPaddingRight | Padding (in pixels) for the right of the form input area. (Android Only) |
{
styles?: StyleProp;
backgroundColor?: string;
cursorColor?: string;
borderColor?: string;
borderWidth?: number;
cornerRadius?: number;
textPaddingLeft?: number;
textPaddingRight?: number;
fieldDividerWidth?: number;
fieldDividerColor?: string;
cardElevation?: number;
textColor?: string;
placeholderColor?: string;
focusedPlaceholderColor?: string;
fontSize?: number;
fontFamily?: string;
fontWeight?: FontWeight;
italic?: boolean;
};
Represents the validation state of a credit card component. This is used in the PaymentCardDetailsForm onFormComplete property and is extended in CardDetails to be used in the PaymentCardDetailsView onCardChange property.
| Property | Description |
|---|---|
isValid | Whether or not the card is in a valid state |
{
isValid: boolean;
}
Options for styling the PaymentCardCvvView component. All colors should be specified in hex format.
| Property | Description |
|---|---|
styles | React Native styles for this view. Default style is { minHeight: 45 } |
borderWidth | The width of the input view's border |
borderColor | The color of the input view's border |
cornerRadius | The corner radius of the input view's border |
backgroundColor | The background color for the input view (Android Only: Requires API 27+) |
textColor | The text color for user-entered text (Android Only: Requires API 27+) |
fontSize | The font size for all text |
fontFamily | The font family used for text |
placeholderColor | The color for placeholder text (Android Only: Requires API 27+) |
cursorColor | The color for the cursor (Android Only: Requires API 29+) |
errorTextColor | The color of the text inside the input field if they are in an error state. Consider changing errorStyles.color when changing this property (Android Only: Requires API 27+) |
fontWeight | The stroke weight of the font in each of the fields. API 28+ can support all font weights. Lower API versions interpret a FontWeight of 700 or above as bold and below 700 as regular (Android Only) |
italic | Determins if the font inside the field should be italic style (Android Only) |
textPaddingLeft | Padding (in pixels) for the left of the card input area |
textPaddingRight | Padding (in pixels) for the right of the card input area |
textAlign | The alignment of the text within the view. The value can be one of left, center, or right |
{
styles?: StyleProp<ViewStyle>;
borderWidth?: number;
borderColor?: string;
cornerRadius?: number;
backgroundColor?: string;
textColor?: string;
fontSize?: number;
fontFamily?: string;
placeholderColor?: string;
cursorColor?: string;
errorTextColor?: string;
fontWeight?: FontWeight;
italic?: boolean;
textPaddingLeft?: number;
textPaddingRight?: number;
textAlign?: "left" | "center" | "right";
}
Extends CardValidationStatus and represents the state of the credit card component. This is used in the PaymentCardDetailsView onCardChange property.
| Property | Description |
|---|---|
isValid | Whether or not the card is in a valid state (See CardValidationStatus) |
cardType | The detected card type, based on user input (See CardType) |
invalidFields | An array of fields that are in an invalid state (See CardField) |
emptyFields | An array of fields that are empty (See CardField) |
errors.editedFieldsError | An error message that is calculated by only looking at the state of fields that have been edited (received and lost focus). |
errors.allFieldsError | An error message that is calculated by looking at the state of all fields, regardless of whether they have been edited. |
{
isValid: boolean;
cardType: CardType;
invalidFields?: CardField[];
emptyFields?: CardField[];
errors?: {
editedFieldsError?: string;
allFieldsError?: string;
}
}
Represents the state of the CVV component. This is used in the PaymentCardCvvView onBlur, onCvvChange, and onFocus properties.
| Property | Description |
|---|---|
state | Provides full insight into the current state of the CVV security code input (See FieldState) |
errors.editedFieldError | An error message that is calculated by only looking at the state of the field if it has been edited (received and lost focus). |
errors.uneditedFieldError | An error message that is calculated by looking at the state of the field, regardless of whether it has been edited. |
{
state: FieldState;
errors?: {
editedFieldError?: string;
uneditedFieldError?: string:
}
}
CVV Update Token used for revalidating a stored credit card
| Property | Description |
|---|---|
id | The CVV update token id |
productionEnvironment | Boolean value indicating if the token was generated in a production environment |
{
id?: string;
productionEnvironment?: boolean;
}
Result type for payment method creation. Contains either a successful payment method or an error.
| Property | Description |
|---|---|
paymentMethod | The payment method, if creation was successful. Undefined if an error occurred. (See PaymentMethod) |
error | Error details, if creation failed. Undefined if creation was successful. (See OloError) |
{ paymentMethod?: PaymentMethod; error?: OloError; }
Result type for CVV update token creation. Contains either a successful token or an error.
| Property | Description |
|---|---|
token | The CVV update token, if creation was successful. Undefined if an error occurred. (See CvvUpdateToken) |
error | Error details, if creation failed. Undefined if creation was successful. (See OloError) |
{ token?: CvvUpdateToken; error?: OloError; }
Represents the entire state of a field
| Property | Description |
|---|---|
isValid | Whether or not the field is in a valid format |
isFocused | Whether or not the field is currently being focused |
isEmpty | Whether or not the field is empty |
wasEdited | Whether or not the field was edited at any point in time, even if it is currently empty |
wasFocused | Whether or not the field was focused at any point |
{
isValid: boolean;
isFocused: boolean;
isEmpty: boolean;
wasEdited: boolean;
wasFocused: boolean;
}
Optional custom defined error messages to that can be displayed in place of default error messages. Any properties not defined will fall back to the default error messages.
| Property | Description |
|---|---|
number | An optional collection of custom error messages for when there is an error with the card number field (See CardField) |
expiration | An optional collection of custom error messages for when there is an error with the card expiration field (See CardField) |
cvv | An optional collection of custom error messages for when there is an error with the card CVV field (See CardField) |
postalCode | An optional collection of custom error messages for when there is an error with the postal code field (See CardField) |
unsupportedCardError | An optional custom error message for when the card type is unsupported by Olo. |
{
number?: CustomFieldError;
expiration?: CustomFieldError;
cvv?: CustomFieldError;
postalCode?: CustomFieldError;
unsupportedCardError?: string;
}
Options for defining custom error messages for different error conditions.
| Property | Description |
|---|---|
emptyError | An error message for when the field is empty. |
invalidError | An error message for when the field is invalid. |
{
emptyError?: string;
invalidError?: string;
}
Options for customing a DigitalWalletButton for Apple Pay.
| Property | Default Value | Description |
|---|---|---|
cornerRadius? | 8 | The radius, in points, for the rounded corners of the button |
style? | black | The style of Apple Pay button to display |
type? | checkout | The type of Apple Pay button to display |
{
cornerRadius?: number;
style?: ApplePayButtonStyle;
type?: ApplePayButtonType;
}
Options for customing a DigitalWalletButton for Google Pay.
| Property | Default Value | Description |
|---|---|---|
cornerRadius? | 8 | The radius, in dp units, for the rounded corners of the button |
theme? | dark | The theme to use for the Google Pay button |
type? | checkout | The type of Google Pay button to display |
{
cornerRadius?: number;
theme?: GooglePayButtonTheme;
type?: GooglePayButtonType;
}
Enable the New Architecture: Follow React Native's migration guide to enable the new architecture in your app
iOS Component Registration: Add the registerOloPayComponents() call in your AppDelegate (see Setup)
Update Payment Method Creation: Replace promise-based calls with callbacks:
Before (v6.x or older)
const createPaymentMethod = async () => {
try {
const paymentMethod = await cardRef.current.createPaymentMethod();
// Use paymentMethod to submit a basket using Olo's ordering API
} catch (error) {
// Handle error
}
};
<PaymentCardDetailsView ref={cardRef} />
<Button title="Submit Payment" onPress={createPaymentMethod} />
After (v7.x)
const createPaymentMethod = () => {
cardRef.current.createPaymentMethod();
};
const handlePaymentMethodResult = (result: PaymentMethodResult) => {
if (result.error) {
// Handle error
return;
}
// Use paymentMethod to submit a basket using Olo's ordering API
const paymentMethod = result.paymentMethod;
};
<PaymentCardDetailsView
ref={cardRef}
onPaymentMethodResult={handlePaymentMethodResult}
/>
<Button title="Submit Payment" onPress={createPaymentMethod} />
Update CVV Token Creation: Replace promise-based calls with callbacks:
Before (v6.x or older)
const createCvvUpdateToken = async () => {
try {
const cvvToken = await cvvRef.current.createCvvUpdateToken();
// Use cvvToken for revalidating a stored credit card
} catch (error) {
// Handle error
}
};
<PaymentCardCvvView ref={cvvRef} />
<Button title="Submit CVV" onPress={createCvvUpdateToken} />
After (v7.x)
const createCvvUpdateToken = () => {
cvvRef.current.createCvvUpdateToken();
};
const handleCvvTokenResult = (result: CvvTokenResult) => {
if (result.error) {
// Handle error
return;
}
// Use cvvToken for revalidating a stored credit card
const cvvToken = result.token;
};
<PaymentCardCvvView
ref={cvvRef}
onCvvTokenResult={handleCvvTokenResult}
/>
<Button title="Submit CVV" onPress={createCvvUpdateToken} />
Issues were discovered during the cutover to supporting the new architecture and were fixed in version 7.0.2 see Changelog for details.
When passing incorrect or invalid parameters, error messages may refer to native platform-specific types that do not exist in JavaScript or Typescript (e.g. Double instead of Number).
cardStyles.errorTextColor, cardStyles.textColor, and cardStyles.placeholderColorcvvStyles.errorTextColor, cvvStyles.textColor, and cvvStyles.placeholderColorUpdates
clear() method to clear all card details on iOSBug Fixes
onCvvChange, onFocus, and onBlur callbacksonFormComplete callback to be called when the entire form's valid state had not changed.Bug Fixes
Breaking Changes
onPaymentMethodResult callback (See PaymentMethodResult)onCvvTokenResult callback (See CvvTokenResult)focus, blur, clear, createPaymentMethod, createCvvUpdateToken) now return void instead of Promise<void> since they execute synchronouslyPromiseRejection type to OloErrorPromiseRejectionCode enum to OloErrorCodeUpdates
Breaking Changes
compileSdkVersion is now v36Updates
Dependency Updates
Android
targetSdkVersion and compileSdkVersion to v36androidx.core:core-ktx:1.17.0org.jetbrains.kotlinx:kotlinx-coroutines-android:1.10.2com.google.android.material:material:1.13.0iOS
Updates
Dependency Updates
iOS
Updates
JCB, DinersClub, and UnionPay cards are now accepted and treated as Discover cardsfullPhoneticNamefullPhoneticNameRequiredDependency Updates
Android
iOS
Overview
Updates
currencyMultiplier propertyfocus() method now takes an optional field parameter to enable programmatic focus of specific card input fieldsfocus() method now takes an optional field parameter to enable programmatic focus of specific card input fieldsPromiseRejectionCode
applePayErrorapplePayTimeoutapplePayEmptyMerchantIdgooglePayNetworkErrorgooglePayDeveloperErrorgooglePayInternalErrorgooglePayInvalidSetupdigitalWalletUninitializeddigitalWalletNotReadyemptyCompanyLabelinvalidCountryCodelineItemsTotalMismatchBreaking Changes
getDigitalWalletPaymentMethod in favor of createDigitalWalletPaymentMethodinitializeGooglePay method in favor of initialize or updateDigitalWalletConfigchangeGooglePayVendor method in favor of updateDigitalWalletConfigisEnabled prop in favor of more convential disabled propisEnabled prop in favor of more convential disabled propisEnabled prop in favor of more convential disabled propapplePayMerchantId property to merchantIdGooglePayInitializationOptions
googlePayProductionEnvironment to productionEnvironmentpaymentMethod property is now nullableerror propertyPromiseRejectionCode
googlePayUninitializedgooglePayNotReadyAndroidInitializationOptionsChangeGooglePayVendorOptionsDigitalWalletErrorGooglePayErrorDigitalWalletTypeGooglePayErrorTypeDependency Updates
Android
minSdkVersion to 24targetSdkVersion and compileSdkVersion to 35sourceCompatibility to JavaVersion.VERSION_17targetCompatibility to JavaVersion.VERSION_17androidx.constraintlayout:constraintlayout:2.2.1androidx.core:core-ktx:1.16.0org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0com.google.android.material:material:1.12.0iOS
Updates
Breaking Changes
generalCardError as an option when setting CustomErrorMessagesUpdates
OloPayInitializationConfig.freshInstall parameter used when initializing the SDKBug Fixes
cardStyles.errorTextColor, cardStyles.textColor, and cardStyles.placeholderColor were not setcvvStyles.errorTextColor, cvvStyles.textColor, and cvvStyles.placeholderColor were not setDependency Updates
Bug Fixes
Bug Fixes
initialize(...) is called multiple timesDependency Updates
Breaking Changes
paddingTop and paddingBottom from PaymentCardDetailsViewStylespaddingLeft to textPaddingLeft in PaymentCardDetailsViewStylespaddingRight to textPaddingRight in PaymentCardDetailsViewStylesPromiseRejectionCode incorrectNumber and merged its use case with invalidNumberPromiseRejectionCode incorrectZip and merged its use case with invalidPostalCodePromiseRejectionCode incorrectCvv and merged its use case with invalidCvvUpdates
productionEnvironment property to PaymentMethodBugfixes
onFocus and onBlur from firing properly for PaymentCardDetailsView on Androidclear() on the PaymentCardDetailsViewfontFamily from being set properly on the PaymentCardDetailsView on Android.Dependency Updates
Breaking Changes
Updates
Bugfixes
getDigitalWalletPaymentMethod()Bugfixes
Olo Pay Software Development Kit License Agreement
Copyright © 2022 Olo Inc. All rights reserved.
Subject to the terms and conditions of the license, you are hereby granted a non-exclusive, worldwide, royalty-free license to (a) copy and modify the software in source code or binary form for your use in connection with the software services and interfaces provided by Olo, and (b) redistribute unmodified copies of the software to third parties. The above copyright notice and this license shall be included in or with all copies or substantial portions of the software.
Your use of this software is subject to the Olo APIs Terms of Use, available at https://www.olo.com/api-usage-terms. This license does not grant you permission to use the trade names, trademarks, service marks, or product names of Olo, except as required for reasonable and customary use in describing the origin of the software and reproducing the content of this license.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Olo Pay React Native SDK
The npm package @olo/pay-react-native receives a total of 690 weekly downloads. As such, @olo/pay-react-native popularity was classified as not popular.
We found that @olo/pay-react-native demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.