1. Build Integration
Steps to integrate your React Native Razorpay custom UI SDK with Razorpay Payment Gateway.
Follow the steps given below to use the SDK and integrate with Razorpay Payment Gateway:
1.1
.1.2
.1.3
.1.4
.1.5
.1.6
.1.7
.1.8
.1.9
.Watch Out!
You can install the SDK using NPM, Yarn and Expo.
To install using NPM, use the command given below:
npm install --save react-native-customui
To install using Yarn, use the command given below:
yarn add react-native-customui
To install using Expo, use the command given below:
npx expo install react-native-customui
Automatic linking is available only for iOS. The steps are given below:
-
Install the Razorpay React Native Custom UI SDK using the npm command.
$ npm install react-native-customui --save -
Navigate to the iOS folder on the terminal and run
pod install
.
Handy Tips
Ensure the Razorpay.framework file is added in the embedded binaries section and that the Always Embed Swift Standard Binaries option is set to Yes in Build Settings.
You can link the SDK manually using CocoaPods. To do this:
-
Add the following line to your build targets in your Podfile.
pod 'react-native-customui', :path => '../node_modules/react-native-customui' -
Run the following command:
pod install
If you do not use CocoaPods, follow these steps to link the SDK manually:
- In XCode, in the Project Navigator:
- Right click Libraries.
- Add Files to
[your project's name]
. - Navigate to
node_modules/react-native-customui
. - Add the
.xcodeproj
file.
- In the project navigator, select your project.
- Add the
libRNDeviceInfo.a
from thedeviceinfo
project to your project's Build Phases ➜ Link Binary With Libraries. - Click the
.xcodeproj
file you added before in the Project Navigator and navigate to the Build Settings tab. Ensure All is selected, and not Basic. - Look for Header Search Paths and ensure it contains both
$(SRCROOT)/../react-native/React
and$(SRCROOT)/../../React
. - Mark both as recursive. It should be marked OK by default.
- Add the
- Run your project using cmd+R.
After adding the react-native-razorpay
package, use the option to prebuild the app. This generates the iOS platform folders in the project to use native-modules.
npx expo prebuild
The application is installed on the device/emulator.
npx expo run:[ios] --device
To link the SDK manually, follow these steps:
-
Open the
android/app/src/main/java/[...]/MainApplication.java
file. Add the following to the imports at the top of the file:import com.razorpay.rn.RazorpayPackage; -
Add
new RazorpayPackage()
to the list returned by thegetPackages()
method. -
Append the following lines to
android/settings.gradle
:include ':react-native-razorpay'project(':react-native-razorpay').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-customui/android') -
Insert the dependencies in
android/app/build.gradle
:implementation project(':react-native-customui')
After adding the react-native-razorpay
package, use the option to prebuild the app. This generates the android platform folders in the project to use native-modules.
npx expo prebuild
The application is installed on the device/emulator.
npx expo run:[android] --device
Order is an important step in the payment process.
- An order should be created for every payment.
- You can create an order using the . It is a server-side API call. Know how to Orders API.
- The
order_id
received in the response should be passed to the checkout. This ties the order with the payment and secures the request from being tampered.
Use this endpoint to create an order using the Orders API.
curl -X POST https://api.razorpay.com/v1/orders-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]-H 'content-type:application/json'-d '{"amount": 100,"currency": "MYR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230,"notes": {"key1": "value3","key2": "value2"}}'
amount
mandatory
integer
The amount to be paid by the customer in sen. For example, if the amount is MYR 500.00, enter 50000
.
currency
mandatory
string
The currency in which the payment should be made by the customer. Length must be of 3 characters.
receipt
optional
string
Your receipt id for this order should be passed here. Maximum length is 40 characters.
notes
optional
json object
Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”
.
partial_payment
optional
boolean
Indicates whether the customer can make a partial payment. Possible values:
true
: The customer can make partial payments.false
(default): The customer cannot make partial payments.
first_payment_min_amount
optional
integer
Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of MYR 7,000.00 is to be received from the customer in two installments of #1 - MYR 5,000.00, #2 - MYR 2,000.00 then you can set this value as 500000
. This parameter should be passed only if partial_payment
is true
.
Know more about
.Descriptions for the response parameters are present in the
parameters table.The error response parameters are available in the
.You can accept payments through Credit and Debit Cards, Wallets, and PayNow as per the methods enabled on your account.
- When you use Razorpay React Native Standard SDK, you do not have to handle the availability of different payment methods.
- When creating a Custom checkout form, you must ensure that only the methods activated for your account are displayed to the customer. To get a list of available payment methods, call
getPaymentMethods
. This fetches the list of payment methods asynchronously and returns the result in JSON format in theonPaymentMethodsReceived
callback.
The following API is used to fetch all enabled payment methods for a given API Key ID:
https://api.razorpay.com/v1/methods?key_id=[Your_Key_ID]
razorpay.getPaymentMethods(new PaymentMethodsCallback() {@Overridepublic void onPaymentMethodsReceived(String result) {JSONObject paymentMethods = new JSONObject(result);}@Overridepublic void onError(String error){}});});
Check the
available with the Razorpay React Native Custom SDK.Handy Tips
If you are using Subscriptions, you can pass the subscription_id
in the options, which fetches subscription related details along with the payment method. This saves you a network call to get amount for that subscription_id
. Know more about
Import Razorpay module to your component:
import Razorpay from 'react-native-customui';
Call the Razorpay.open
method with the payment options. The method returns a JS Promise, where:
- The then part corresponds to a successful payment.
- The catch part corresponds to payment failure.
<TouchableHighlight onPress={() => {var options = {description: 'Credits towards consultation',currency: 'MYR',key_id: '<YOUR_KEY_ID>',amount: '5000',email: "nur.aisyah@example.com",contact: "+60345675444"method: 'wallet',wallet: 'touchngo'}Razorpay.open(options).then((data) => {// handle successalert(`Success: ${data.razorpay_payment_id}`);}).catch((error) => {// handle failurealert(`Error: ${error.code} | ${error.description}`);});}}>
Know more about
.key
mandatory
string
API Key ID generated from the Curlec Dashboard.
amount
mandatory
integer
The amount to be paid by the customer in sen. For example, if the amount is MYR 500.00, enter 50000
.
currency
mandatory
string
The currency in which the payment should be made by the customer. Length must be of 3 characters.
description
optional
string
Description of the product shown in the Checkout form. It must start with an alphanumeric character.
image
optional
string
Link to an image (usually your business logo) shown in the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.
order_id
mandatory
string
Order ID generated via the
notes
optional
object
Set of key-value pairs that can be used to store additional information about the payment. It can hold a maximum of 15 key-value pairs, each 256 characters long (maximum).
method
mandatory
string
The payment method used by the customer on Checkout.
Possible values:
card
(default)fpx
(default)wallet
(default)
card
mandatory if method=card
object
The details of the card that should be entered while making the payment.
number
integer
Unformatted card number.
name
string
The name of the cardholder.
expiry_month
integer
Expiry month for card in MM format.
expiry_year
integer
Expiry year for card in YY format.
cvv
integer
CVV printed on the back of the card.
Handy Tips
- CVV is not required by default for tokenised cards across all networks.
- CVV is optional for tokenised card payments. Do not pass dummy CVV values.
- To implement this change, skip passing the
cvv
parameter entirely, or pass anull
or empty value in the CVV field. - We recommend removing the CVV field from your checkout UI/UX for tokenised cards.
- If CVV is still collected for tokenised cards and the customer enters a CVV, pass the entered CVV value to Razorpay.
bank
mandatory if method=fpx
string
Bank code. List of available banks enabled for your account can be fetched via
wallet
mandatory if method=wallet
string
Wallet code for the wallet used for the payment. Possible values:
touchngo
(default)grabpay
(default)
wallet
mandatory if method=wallet
string
Wallet code for the wallet used for the payment. Possible values:
touchngo
(default)grabpay
(default)
callback_url
optional
string
The URL to which the customer must be redirected upon completion of payment. The URL must accept incoming POST
requests. The callback URL will have razorpay_payment_id
, razorpay_order_id
and razorpay_signature
as the request parameters for a successful payment.
redirect
conditionally mandatory
boolean
Determines whether customer should be redirected to the URL mentioned in the
callback_url
parameter. This is mandatory if callback_url
parameter is used. Possible values:
true
: Customer will be redirected to thecallback_url
.false
: Customer will not be redirected to thecallback_url
.
A successful payment returns the following fields to the Checkout form.
- You need to store these fields in your server.
- You can confirm the authenticity of these details by verifying the signature in the next step.
razorpay_payment_id
string
Unique identifier for the payment returned by Checkout only for successful payments.
razorpay_order_id
string
Unique identifier for the order returned by Checkout.
razorpay_signature
string
Signature returned by the Checkout. This is used to verify the payment.
This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.
To verify the razorpay_signature
returned to you by the Checkout form:
-
Create a signature in your server using the following attributes:
order_id
: Retrieve theorder_id
from your server. Do not use therazorpay_order_id
returned by Checkout.razorpay_payment_id
: Returned by Checkout.key_secret
: Available in your server. Thekey_secret
that was generated from the .
-
Use the SHA256 algorithm, the
razorpay_payment_id
and theorder_id
to construct a HMAC hex digest as shown below:generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);if (generated_signature == razorpay_signature) {payment is successful} -
If the signature you generate on your server matches the
razorpay_signature
returned to you by the Checkout form, the payment received is from an authentic source.
Given below is the sample code for payment signature verification:
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");String secret = "EnLs21M47BllR3X8PSFtjtbd";JSONObject options = new JSONObject();options.put("razorpay_order_id", "order_IEIaMR65cu6nz3");options.put("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");options.put("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f");boolean status = Utils.verifyPaymentSignature(options, secret);
After you have completed the integration, you can
, make test payments, replace the test key with the live key and integrate with other .If you use M1 MacBook, you need to make the following changes in your podfile.
Handy Tips
Add the following code inside post_install do |installer|
.
installer.pods_project.build_configurations.each do |config|config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"] = "arm64"end
Handy Tips
On the Dashboard, ensure that the payment status is captured
. Refer to the payment capture settings page to know how to
You can track the payment status in three ways:
To verify the payment status from the Dashboard:
- Log in to the and navigate to Transactions → Payments.
- Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.
Is this integration guide useful?