Watch this video to integrate Razorpay Payment Gateway on your React Native Android app.
Handy Tips
The compileSdkVersion is the version of Android. Increase the value of minSdkVersion to at least 19 in the build.gradle file in the Android folder to work with the latest Android SDK Build Tools version. Using it with a lower minSdkVersion version will lead to errors.
Follow the steps to integrate Razorpay React Native SDK for Android.
Install the SDK using the following npm command in the Terminal window. If you are using Windows, please use Git Bash instead of the Command Prompt window. Ensure that you run this code within your React Native project folder in the Terminal window.
CopyRazorpayClient client = new RazorpayClient(your_key_id, your_secret);
Dictionary<string, object> options = new Dictionary<string,object>();
options.Add("amount", 50000); // amount in the smallest currency unit
options.add("receipt", "order_rcptid_11");
options.add("currency", "INR");
Order order = client.Order.Create(options);
Here is the list of parameters for creating an order:
amountmandatory
integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.
currencymandatory
string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.
receiptoptional
string Your receipt id for this order should be passed here. Maximum length 40 characters.
notesoptional
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_paymentoptional
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_amountoptional
integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.
Call the RazorpayCheckout.open method with the payment options. The method returns a JS Promise where the then part corresponds to a successful payment and the catch part corresponds to payment failure.
Copy<TouchableHighlight onPress={() => {
var options = {
description: 'Credits towards consultation',
image: 'https://i.imgur.com/3g7nmJC.png',
currency: 'INR',
key: '<YOUR_KEY_ID>',
amount: '5000',
name: 'Acme Corp',
order_id: 'order_DslnoIgkIDL8Zt',//Replace this with an order_id created using Orders API.prefill: {
email: 'gaurav.kumar@example.com',
contact: '9191919191',
name: 'Gaurav Kumar'
},
theme: {color: '#53a20e'}
}
RazorpayCheckout.open(options).then((data) => {
// handle successalert(`Success: ${data.razorpay_payment_id}`);
}).catch((error) => {
// handle failurealert(`Error: ${error.code} | ${error.description}`);
});
}}>
You must pass these parameters in Checkout to initiate the payment.
keymandatory
string API Key ID generated from the Razorpay Dashboard.
amountmandatory
integer The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100, enter 10000.
currencymandatory
string The currency in which the payment should be made by the customer. See the list of supported currencies.
namemandatory
string The business name shown on the Checkout form.
descriptionoptional
string Description of the purchase item shown on the Checkout form. Must start with an alphanumeric character.
imageoptional
string Link to an image (usually your business logo) shown on the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.
object You can prefill the following details at Checkout.
nameoptional
string Cardholder's name to be pre-filled if customer is to make card payments on Checkout.
emailoptional
string Email address of the customer.
contactoptional
string Phone number of the customer. The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside India. Examples:
+14155552671 (a valid non-Indian number)
+919977665544 (a valid Indian number). If 9977665544 is entered, +91 is added to it as +919977665544.
methodoptional
string Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values
card
netbanking
wallet
emi
upi
notesoptional
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).
theme
object Thematic options to modify the appearance of Checkout.
hide_topbaroptional
boolean Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values are:
true: Hides the top bar
false (default): Displays the top bar.
coloroptional
string Enter your brand colour's HEX code to alter the appearance of Checkout form.
backdrop_coloroptional
string Enter a HEX code to change the Checkout's backdrop colour.
modal
object Options to handle the Checkout modal.
backdropcloseoptional
boolean Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values are:
true: Closes the form when your customer clicks outside the checkout form.
false (default): Does not close the form when customer clicks outside the checkout form.
escapeoptional
boolean Indicates whether pressing the escape key should close the Checkout form. Possible values are:
true (default): Closes the form when the customer presses the escape key.
false: Does not close the form when the customer presses the escape key.
handlebackoptional
boolean Determines whether Checkout must behave similar to the browser when back button is pressed. Possible values:
true (default): Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout modal is open.
false: Checkout does not simulate a back press when browser's back button is pressed.
confirm_closeoptional
boolean Determines whether a confirmation dialog box should be shown when customers attempt to close Checkout. Possible values:
true: Confirmation dialog box is shown.
false (default): Confirmation dialog box is not shown.
ondismissoptional
function Used to track the status of Checkout. You can pass a modal object with ondismiss: function(){} as options. This function is called when the modal is closed by the user.
animationoptional
boolean Show an animation before loading of Checkout.
true(default): Animation appears.
false: Animation does not appear.
subscription_idoptional
string If you are accepting recurring payments using Razorpay Checkout, you should pass the relevant subscription_id to the Checkout. Know more about Subscriptions on Checkout.
subscription_card_changeoptional
boolean Permit or restrict customer from changing the card linked to the subscription. You can also do this from the hosted page. Possible values:
true: Allow the customer to change the card from Checkout.
false (default): Do not allow the customer to change the card from Checkout.
false (default): You are not accepting recurring payments.
callback_urloptional
string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted.
redirectoptional
boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url must be passed while using this parameter. Possible values:
true: Customer is redirected to the specified callback URL in case of payment failure.
false (default): Customer is shown the Checkout popup to retry the payment.
integer Sets a timeout on Checkout, in seconds. After the specified time limit, customer will not be able to use Checkout.
remember_customeroptional
boolean Determines whether to allow saving of cards. Can also be configured via the Razorpay Dashboard. Possible values:
true: Enables card saving feature.
false (default): Disables card saving feature.
readonly
object Marks fields as read-only.
contactoptional
boolean Used to set the contact field as readonly. Possible values:
- true: Customer will not be able to edit this field.
- false (default): Customer will be able to edit this field.
emailoptional
boolean Used to set the email field as readonly. Possible values:
- true: Customer will not be able to edit this field.
- false (default): Customer will be able to edit this field.
nameoptional
boolean Used to set the name field as readonly. Possible values:
- true: Customer will not be able to edit this field.
- false (default): Customer will be able to edit this field.
send_sms_hashoptional
boolean Used to auto-read OTP for cards and net banking pages. Applicable from Android SDK version 1.5.9 and above. Possible values:
true: OTP is auto-read.
false (default): OTP is not auto-read.
allow_rotationoptional
boolean Used to rotate payment page as per screen orientation. Applicable from Android SDK version 1.6.4 and above. Possible values:
true: Payment page can be rotated.
false (default): Payment page cannot be rotated.
retryoptional
object Parameters that enable retry of payment on the checkout.
enabled
boolean Determines whether the customers can retry payments on the checkout. Possible values:
true (default): Enables customers to retry payments.
false: Disables customers from retrying the payment.
max_count
integer The number of times the customer can retry the payment. Recommended to set this to 4. Having a larger number here can cause loops to occur.
configoptional
object Parameters that enable configuration of checkout display language.
display
object Child parameter that enables configuration of checkout display language.
language
string The language in which checkout should be displayed. Possible values:
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 the order_id from your server. Do not use the razorpay_order_id returned by Checkout.
razorpay_payment_id: Returned by Checkout.
key_secret: Available in your server. The key_secret that was generated from the Razorpay Dashboard.
Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:
Copygenerated_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 are the sample codes for payment signature verification.
Copy/**
* This class defines common routines for generating
* authentication signatures for Razorpay Webhook requests.
*/publicclassSignature
{
privatestaticfinalStringHMAC_SHA256_ALGORITHM="HmacSHA256";
/**
* Computes RFC 2104-compliant HMAC signature.
* * @param data
* The data to be signed.
* @param key
* The signing key.
* @return
* The Base64-encoded RFC 2104-compliant HMAC signature.
* @throws
* java.security.SignatureException when signature generation fails
*/publicstatic String calculateRFC2104HMAC(String data, String secret)throws java.security.SignatureException
{
String result;
try {
// get an hmac_sha256 key from the raw secret bytesSecretKeySpecsigningKey=newSecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM);
// get an hmac_sha256 Mac instance and initialize with the signing keyMacmac= Mac.getInstance(HMAC_SHA256_ALGORITHM);
mac.init(signingKey);
// compute the hmac on input data bytesbyte[] rawHmac = mac.doFinal(data.getBytes());
// base64-encode the hmac
result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase();
} catch (Exception e) {
thrownewSignatureException("Failed to generate HMAC : " + e.getMessage());
}
return result;
}
}
Copyimport (
"crypto/hmac""crypto/sha256""crypto/subtle""encoding/hex""fmt"
)
funcmain() {
signature := "477d1cdb3f8122a7b0963704b9bcbf294f65a03841a5f1d7a4f3ed8cd1810f9b"
secret := "qp3zKxwLZxbMORJgEVWi3Gou"
data := "order_J2AeF1ZpvfqRGH|pay_J2AfAxNHgqqBiI"//fmt.Printf("Secret: %s Data: %s\n", secret, data)// Create a new HMAC by defining the hash type and the key (as byte array)
h := hmac.New(sha256.New, []byte(secret))
// Write Data to it
_, err := h.Write([]byte(data))
if err != nil {
panic(err)
}
// Get result and encode as hexadecimal string
sha := hex.EncodeToString(h.Sum(nil))
fmt.Printf("Result: %s\n", sha)
if subtle.ConstantTimeCompare([]byte(sha), []byte(signature)) == 1 {
fmt.Println("Works")
}
}
After you have successfully completed the integration, you can set up webhooks, make test payments, replace test key with live key and integrate with other APIs.
You can use Razorpay Webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL. Know how to set up Webhooks.