Spreedly Checkout React Native Example App

Demonstration only — not for production. This sample app shows integration patterns for the Spreedly Checkout React Native SDK. Do not ship it as-is to end users.

Synced from SDK release 1.0.10 (tag v1.0.10).

This example demonstrates payment flows using the Spreedly Checkout SDK, including card payments, 3D Secure, offsite payments, Stripe APM, Braintree, ACH, and EBANX.

Getting Started

Prerequisites

• React Native environment set up
• Node.js 20+
• Xcode 15.4+ (iOS)
• GitHub account with access to Spreedly private packages
• GitHub Personal Access Token with read:packages scope (export as GITHUB_TOKEN in your shell; do not commit tokens)

Setup

# 1. Clone the repository
git clone https://github.com/spreedly/checkout-react-native-example.git
cd checkout-react-native-example

# 2. Create your environment file
cp .env.example .env
# Fill in your credentials in .env (placeholders only in .env.example)

# 3. Install dependencies
export GITHUB_TOKEN=<your-github-token>
yarn install

# 4. iOS setup
cd ios && pod install && cd ..

# 5. Run the app
yarn ios     # or yarn android

Documentation

Merchant docs are under /docs/. Guides below match files synced into this repository.

Integration Guides

Guide	Description
Integration Guide	Installation, initialization, and complete integration walkthrough
Express Checkout	Express checkout payment flow
Hosted Fields	Custom checkout with individual hosted field components
Hosted Fields and Express capabilities	Capability map across Hosted Fields, Express, and core APIs
3DS Guide	Forter-based 3D Secure authentication
3DS Gateway Guide	Gateway-managed 3DS via browser-based authentication
Theme Guide	Colors, typography, and styling customization
ACH Bank Account	Drop-in ACH sheet and custom bank account forms
CVV Recaching	CVV recaching for saved payment methods
Offsite Payments	PayPal, Pix, Boleto via offsite flows
Stripe APM	iDEAL, Bancontact, EPS, P24, SEPA via Stripe
Braintree Payments	PayPal and Venmo via Braintree
EBANX Payments	EBANX alternative payment methods
RN 0.79+ Requirements	React Native 0.79+ version-specific requirements

Security & Privacy

Guide	Description
Security	Security policy, vulnerability reporting, and best practices
Android Data Safety	Android data safety declarations and requirements
iOS Privacy	iOS privacy manifest and App Store requirements
Unified Privacy	Cross-platform privacy documentation

Testing & Migration

Guide	Description
Testing Guide	Test cards, environments, and flow-by-flow testing
From legacy iFrame	API mapping from web iFrame / WebView checkout
v0 to v1	Upgrading between major versions of the RN SDK

Other

• Docs index
• Changelog

Compatibility

• React Native: 0.79+
• Node: 20+
• Xcode: 15.4+
• Android: minSdk 26 (Android 8.0+), targetSdk 34, compileSdk 36
• iOS: 15.1+
• Architectures: Legacy and New Architecture (Fabric/TurboModules)

Support

• Developer docs: developer.spreedly.com
• Support: support.spreedly.com
• Distribution packages: checkout-react-native-packages
• Security policy: SECURITY.md

License

Copyright 2025 Spreedly, Inc.

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Legal

• Terms of Service
• Privacy Policy
• License (Apache 2.0)