React Native with Node Backend (Beta)

Integrate hyper SDK to your React Native App using hyperswitch-node

Currently in beta please contact to get early access

Use this guide to integrate hyper SDK to your React Native app. You can use the following Demo App as a reference with your Hyperswitch credentials to test the setup.

Before following these steps, please configure your payment methods here.


1. Setup the server

1.1 Install the hyperswitch-node library

Install the package and import it in your code

$ npm install @juspay-tech/hyperswitch-node

1.2 Create a payment

Before creating a payment, import the hyper dependencies and initialize it with your API key. Get your API key from Hyperswitch dashboard.

const hyper = require("@juspay-tech/hyperswitch-node")(β€˜YOUR_API_KEY’);

Add an endpoint on your server that creates a Payment. Creating a Payment helps to establish the intent of the customer to start a payment. It also helps to track the customer’s payment lifecycle, keeping track of failed payment attempts and ensuring the customer is only charged once. Return the client_secret obtained in the response to securely complete the payment on the client.

// Create a Payment with the order amount and currency"/create-payment", async (req, res) => {
  try {
    const paymentIntent = await hyper.paymentIntents.create({
      currency: "USD",
      amount: 100,
    // Send publishable key and PaymentIntent details to client
      clientSecret: paymentIntent.client_secret,
  } catch (err) {
    return res.status(400).send({
      error: {
        message: err.message,

2. Build checkout page on the client

2.1 Install the react-native-hyperswitch libraries

Install the packages and import it into your code

$ npm install @juspay-tech/hyperswitch-sdk-react-native

2.2 Peer Dependencies

Install the following dependencies

yarn add react-native-code-push
yarn add react-native-gesture-handler
yarn add react-native-inappbrowser-reborn
yarn add react-native-klarna-inapp-sdk
yarn add react-native-safe-area-context
yarn add react-native-svg
yarn add @sentry/react-native

2.3 iOS Only

Run pod install in iOS folder

pod install

2.4 Android Only

In the Android Folder inside strings.xml file(android/app/src/main/res/values/strings.xml) add the below line

<string name="CodePushDeploymentKey">HyperswitchRNDemo</string>

In the Android Folder inside settings.gradle file add the following line


project(":react-native-code-push").projectDir = new File(

2.5 Add HyperProvider to your React Native app

Use HyperProvider to ensure that you stay PCI compliant by sending payment details directly to Hyperswitch server.

import { HyperProvider } from "@juspay-tech/react-native-hyperswitch";

2.6 Use HyperProvider

To initialize Hyperswitch in your React Native app, wrap your payment screen with the HyperProvider component. Only the API publishable key in publishableKey is required. The following example shows how to initialize Hyperswitch using the HyperProvider component.

import { HyperProvider } from "@juspay-tech/react-native-hyperswitch ";

function App() {
  return (
    <HyperProvider publishableKey="YOUR_PUBLISHABLE_KEY">
      // Your app code here

3. Complete the checkout on the client

3.1 import useHyper to your checkout page

In the checkout of your app, import useHyper() hook

import { useHyper } from "@juspay-tech/react-native-hyperswitch";

3.2 Fetch the PaymentIntent client Secret

Make a network request to the backend endpoint you created in the previous step. The clientSecret returned by your endpoint is used to complete the payment.

const fetchPaymentParams = async () => {
  const response = await fetch(`${API_URL}/create-payment`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    body: JSON.stringify({ items: [{ id: "xl-tshirt" }], country: "US" }),
  const val = await response.json();
  return val;

3.3 Collect Payment details

Call initPaymentSession from the useHyper hook to customise paymentsheet, billing or shipping addresses and initialize paymentsheet

const { initPaymentSession, presentPaymentSheet } = useHyper();
const [paymentSession,setPaymentSession]=React.useState(null);
const initializePaymentSheet = async () => {
  const { clientSecret } = await fetchPaymentParams();

  const customAppearance = {
    colors: {
      light: {
        primary: "#00FF00",
  const params={
      merchantDisplayName: "Example, Inc.",
      clientSecret: clientSecret,
      appearance: customAppearance,
  const paymentSession = await initPaymentSession(params);

useEffect(() => {
}, []);

3.4 Handle Payment Response

To display the Payment Sheet, integrate a "Pay Now" button within the checkout page, which, when clicked, invokes the presentPaymentSheet() function. This function will return an asynchronous payment response with various payment status.

const openPaymentSheet = async () => {
  const status = await presentPaymentSheet(paymentSession);
  console.log("presentPaymentSheet response: ", status);
  const { error, paymentOption } = status;
  if (error) {
    switch (error.code) {
      case "cancelled":
        Alert.alert("cancelled", `PaymentSheet was closed`);
      case "failed":
        Alert.alert("failed", `Payment failed`);
        Alert.alert("status not captured", "Please check the integration");

    Alert.alert(`Error code: ${error.code}`, error.message);
  } else if (paymentOption) {
    switch (paymentOption.label) {
      case "succeeded":
        Alert.alert("succeeded", `Your order is succeeded`);
      case "requires_capture":
        Alert.alert("requires_capture", `Your order is requires_capture`);
        Alert.alert("status not captured", "Please check the integration");
  } else {
    Alert.alert("Something went wrong", "Please check the integration");

return (
    <Button variant="primary" title="Checkout" onPress={openPaymentSheet} />

Congratulations! Now that you have integrated the payment sheet

Last updated