Getting started with the SDK

Including the SDK

You can install the SDK with your favorite package manager (e.g.,npm, yarn):

npm install @payrails/react-native-sdk
or 
yarn add @payrails/react-native-sdk

Initializing the SDK

Initialize a Payrails client as shown below, with configuration:

import { PayrailsProvider } from "@payrails/react-native-sdk";

const App = () => {
  const config = useFetch("https://give.me.sdk-config.com");

  return (
    <PayrailsProvider config={config}>
      // Other elements goes here.
    </PayrailsProvider>
  );
};

Your backend should call the Initialize a client SDK endpoint, then forward the response to the SDK.

Optional: custom return URLs for redirect payments

If your integration uses redirect-based payment methods such as Lean or Generic Redirect, you can also pass returnInfo to PayrailsProvider.

<PayrailsProvider
  config={config}
  returnInfo={{ // Deep links or universal links of your app
    success: 'myapp://payment/success',
    cancel: 'myapp://payment/cancel',
    error: 'myapp://payment/error',
    pending: 'myapp://payment/pending',
  }}
>
  {/* Other elements go here. */}
</PayrailsProvider>

• If returnInfo is omitted, the SDK uses its default hosted return URLs instead.

• The base return URLs must also be configured in the Payrails Admin Portal. Contact the Payrails team for that setup.

• returnInfo defines where the payment provider redirects the user. Redirection does not emit terminal SDK callbacks such as onAuthorizeSuccess, onAuthorizeFailure, or onAuthorizeCancel.