React Native SDK for Stripe Terminal
Stripe Terminal enables you to build your own in-person checkout to accept payments in the physical world. Built on Stripe’s payments network, Terminal helps you unify your online and offline payment channels. With the Stripe Terminal React Native SDK, you can connect to pre-certified card readers from your React Native app and drive a customized in-store checkout flow.
Get started with our 📚 integration guides and example project, or 📘 browse the SDK reference.
Updating to a newer version of the SDK? See our release notes.
7.9.0 and above.plugin-transform-typescript plugin in your project.The React Native SDK includes an open-source example app, which you can use to familiarize yourself with the SDK and reader before starting your own integration.
To build the example app from source, you’ll need to:
yarn bootstrap from the root directory to build the SDK.example-app folder and run yarn install to install all example app dependencies..env.example to .env, and set the URL of the Heroku app you just deployed.yarn ios or yarn android depending on which platform you would like to build.yarn add @stripe/stripe-terminal-react-native
or
npm install @stripe/stripe-terminal-react-native
To initialize Stripe Terminal SDK in your React Native app, use the StripeTerminalProvider component in the root component of your application.
First, create an endpoint on your backend server that creates a new connection token via the Stripe Terminal API.
Next, create a token provider that will fetch connection token from your server and provide it to StripeTerminalProvider as a parameter.
Stripe Terminal SDK will fetch it when it’s needed.
// Root.tsx
import { StripeTerminalProvider } from '@stripe/stripe-terminal-react-native';
function Root() {
const fetchTokenProvider = async () => {
const response = await fetch(`${API_URL}/connection_token`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
});
const { secret } = await response.json();
return secret;
};
return (
<StripeTerminalProvider
logLevel="verbose"
tokenProvider={fetchTokenProvider}
>
<App />
</StripeTerminalProvider>
);
}
As a last step, simply call initialize method from useStripeTerminal hook.
Please note that initialize method must be called from a nested component of StripeTerminalProvider.
// App.tsx
function App() {
const { initialize } = useStripeTerminal();
useEffect(() => {
initialize();
}, [initialize]);
return <View />;
}
Stripe Terminal SDK provides dedicated hook which exposes bunch of methods and props to be used within your App.
Additionally, you have access to the internal state of SDK that contains information about the current connection, discovered readers and loading state.
// PaymentScreen.tsx
import { useStripeTerminal } from '@stripe/stripe-terminal-react-native';
export default function PaymentScreen() {
const { discoverReaders, connectedReader, discoveredReaders } =
useStripeTerminal({
onUpdateDiscoveredReaders: (readers) => {
// access to discovered readers
},
onDidChangeConnectionStatus: (status) => {
// access to the current connection status
},
});
useEffect(() => {
const { error } = await discoverReaders({
discoveryMethod: 'bluetoothScan',
simulated: true,
});
}, [discoverReaders]);
return <View />;
}
In case your app uses React Class Components you can use dedicated withStripeTerminal Higher-Order-Component.
Please note that unlike the hooks approach, you need to use event emitter to listen on specific events that comes from SDK.
Here you can find the list of available events to be used within the event emitter.
Example:
// PaymentScreen.tsx
import {
withStripeTerminal,
WithStripeTerminalProps,
CHANGE_CONNECTION_STATUS,
Reader,
} from '@stripe/stripe-terminal-react-native';
class PaymentScreen extends React.Component {
componentDidMount() {
this.discoverReaders();
const eventSubscription = props.emitter.addListener(
CHANGE_CONNECTION_STATUS, // didChangeConnectionStatus
(status: Reader.ConnectionStatus) => {
// access to the current connection status
}
);
}
async discoverReaders() {
this.props.discoverReaders({
discoveryMethod: 'bluetoothScan',
simulated: true,
});
}
}
export default withStripeTerminal(PaymentScreen);
The SDK provides comprehensive error handling through StripeError objects, giving you detailed information about failures and their context.
All SDK methods return errors as StripeError objects with a consistent structure across platforms.
interface StripeError extends Error {
name: 'StripeError';
message: string; // Human-readable error message
code: ErrorCode; // SDK error code (e.g., 'BLUETOOTH_ERROR')
nativeErrorCode: string; // Platform-specific error code
/** Platform-specific metadata (flexible map structure) */
metadata: Record<string, unknown>;
/** Associated PaymentIntent (if applicable) */
paymentIntent?: PaymentIntent.Type;
/** Associated SetupIntent (if applicable) */
setupIntent?: SetupIntent.Type;
/** Associated Refund (if applicable, iOS only) */
refund?: Refund.Props;
/** API-level error information (unified across platforms) */
apiError?: ApiErrorInformation;
/** Underlying error information (unified structure) */
underlyingError?: UnderlyingErrorInformation;
}
apiError: Structured Stripe API error details (when applicable):
interface ApiErrorInformation {
code: string; // API error code (e.g., 'card_declined')
message: string; // API error message
declineCode: string; // Decline code (e.g., 'insufficient_funds')
type?: string; // Error type (e.g., 'card_error')
charge?: string; // Related charge ID
docUrl?: string; // Documentation URL
param?: string; // Parameter that caused the error
}
underlyingError: Low-level error details from the platform SDK:
interface UnderlyingErrorInformation {
code: string; // Error code or exception class
message: string; // Error message
iosDomain?: string; // iOS: NSError domain
iosLocalizedFailureReason?: string; // iOS: Localized failure reason
iosLocalizedRecoverySuggestion?: string; // iOS: Recovery suggestion
}
The metadata field contains additional platform-specific debugging information.
On iOS, this may include fields like deviceBannedUntilDate, prepareFailedReason, httpStatusCode, readerMessage, stripeAPIRequestId, stripeAPIFailureReason, and offlineDeclineReason.
On Android, the metadata field is reserved for future platform-specific fields and is currently empty.
See the contributor guidelines to learn how to contribute to the repository.