1. Build Integration
Steps to integrate your Custom Flutter application with Razorpay Payment Gateway.
Follow these steps to integrate your Flutter application with the Razorpay Payment Gateway:
1.1
.1.2
.1.3
.1.4
.1.5
.1.6
.1.7
.1.8
.1.9
.1.10
.1.11
.Handy Tips
After you complete the integration:
- Set up webhooks
- Make test payments
- Replace Test API keys with Live API keys
- Integrate with other APIs
Refer to the .
Add the below code to dependencies
in your app's pubspec.yaml
:
razorpay_flutter_customui: 1.0.0
If you are using Proguard for your builds, you need to add the following lines to the Proguard files:
-keepattributes *Annotation*-dontwarn com.razorpay.**-keep class com.razorpay.** {*;}-optimizations !method/inlining/-keepclasseswithmembers class * {public void onPayment*(...);}
Know more about
.Run flutter packages get
in the root directory of your app.
Handy Tips
- For Android, ensure that the minimum API level for your app is 19 or higher.
- For iOS, ensure that the minimum deployment target for your app is iOS 10.0 or higher. Also, don't forget to enable bitcode for your project.
Use the below code to import the razorpay_flutter_customui.dart
file to your project:
import 'package:razorpay_flutter_customui/razorpay_flutter_customui.dart';
For Android, use the below code to create a Razorpay instance:
_razorpay = Razorpay();
For iOS, you need to initialise and instantiate the SDK using the following method:
@overridevoid initState() {_razorpay = Razorpay();_razorpay.initializeSDK(key);}
The plugin uses event-based communication and emits events when payments fail or succeed.
- The event names are exposed via the constants
EVENT_PAYMENT_SUCCESS
andEVENT_PAYMENT_ERROR
from theRazorpay
class. - Use the
on(String event, Function handler)
method on the Razorpay instance to attach event listeners.
_razorpay.on(Razorpay.EVENT_PAYMENT_SUCCESS, _handlePaymentSuccess);_razorpay.on(Razorpay.EVENT_PAYMENT_ERROR, _handlePaymentError);
The handlers would be defined in the class as:
void _handlePaymentSuccess(PaymentSuccessResponse response) {// Do something when payment succeeds}void _handlePaymentError(PaymentFailureResponse response) {// Do something when payment fails}
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.
The following is a sample API request and response for creating an order:
curl -X POST https://api.razorpay.com/v1/orders-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]-H 'content-type:application/json'-d '{"amount": 50000,"currency": "INR","receipt": "rcptid_11","partial_payment": true,"first_payment_min_amount": 23000}'
Here is the list of parameters and their description for creating an order:
amount
mandatory
integer
The transaction amount, expressed in the currency subunit. For example, for an actual amount of ₹299.35, the value of this field should be 29935
.
currency
mandatory
string
The currency in which the transaction should be made. See the
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.
id
mandatory
string
Unique identifier of the customer. For example, cust_1Aa00000000004
.
Know more about
.The error response parameters are available in the
.Pass the Checkout options. Ensure that you pass the order_id
that you received in the response of the previous step.
var options = {"key": key,"amount": 29935,"order_id": "order_EMBFqjDHEEn80l", // Generate order_id using Orders API,"card[cvv]": <CVV>,"card[expiry_month]": 11,"card[expiry_year]": 25,"card[name]": "Test User","card[number]": "4111111111111111","contact": "9900990099","currency": "INR","email": "gaurav.kumar@example.com","description": "Fine T-Shirt","method": "card"};_razorpay.submit(options);
You must pass these parameters in Checkout to initiate the payment.
key
mandatory
string
API Key ID generated from Dashboard → Account & Settings →
amount
mandatory
integer
The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100.00, enter 10000
.
currency
mandatory
string
The currency in which the payment should be made by the customer. For example, INR
. See the list of
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
card
mandatory if method=card/emi
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 Visa and Amex tokenised cards.
- To enable CVV-less flow for Rupay and MasterCard, contact our .
- CVV is mandatory for Diners tokenised cards.
- CVV is an optional field. Skip passing the
cvv
parameter to Razorpay to implement this change.
emi_duration
integer
Defines the number of months in the EMI plan.
bank_account
mandatory if method=emandate
The details of the bank account that should be passed in the request. These details include bank account number, IFSC code and the name of the customer associated with the bank account.
account_number
string
Bank account number used to initiate the payment.
ifsc
string
IFSC of the bank used to initiate the payment.
name
string
Name associated with the bank account used to initiate the payment.
bank
mandatory if method=netbanking
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:
freecharge
(default)payzapp
(default)olamoney
(requires )phonepe
(requires )airtelmoney
(requires )mobikwik
(requires )jiomoney
(requires )amazonpay
(requires )paypal
(requires )phonepeswitch
(requires )
provider
mandatory if method=cardless_emi/paylater
string
Name of the cardless EMI provider partnered with Razorpay.
Available options for Cardless EMI (requires
):barb
cshe
hdfc
icic
idfb
kkbk
krbe
zestmoney
earlysalary
tvsc
walnut369
Available options for Pay Later:
-
)rzpx_postpaid
( -
getsimpl
(default) -
icic
(default) -
)hdfc
( -
lazypay
Watch Out!
LazyPay services are temporarily disabled.
vpa
mandatory if method=upi
string
UPI ID used for making the payment on the UPI app.
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
Provide your customers with a better payment experience by enabling UPI Intent on your app's Checkout form. In the UPI Intent flow:
- Customer selects UPI as the payment method in your iOS app. A list of UPI apps supporting the intent flow is displayed. For example, PhonePe, Google Pay and Paytm.
- Customer selects the preferred app. The UPI app opens with pre-populated payment details.
- Customer enters their UPI PIN to complete their transactions.
- Once the payment is successful, the customer is redirected to your app or website.
To enable this in your iOS integration, you must make the following changes in your app's info.plist file.
<key>LSApplicationQueriesSchemes</key><array><string>tez</string><string>phonepe</string><string>paytmmp</string></array>
Know more about
.Configure and initiate a recurring payment transaction on UPI Intent:
let options: [String:Any] = ["key": "YOUR_KEY_ID","order_id": "order_DBJOWzybfXXXX","customer_id": "cust_BtQNqzmBlXXXX","prefill": ["contact": "+919000090000","email": "gaurav.kumar@example.com"],"image": "https://spaceplace.nasa.gov/templates/featured/sun/sunburn300.png","amount": 10000, // Amount should match the order amount"currency": "INR","recurring": 1 // This key value pair is mandatory for Intent Recurring Payment.]
Use the below code to open the Razorpay checkout:
_razorpay.submit(options);
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
You can track the payment status in three ways:
- .
- .
- .
Handy Tips
- On the Dashboard, ensure that the payment status is
captured
. Refer to the payment capture settings page to know how to . - Subscribe to our webhooks or poll the Fetch a Payment API to track the payment status.
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.
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
If you have subscribed to the order.paid
webhook event, you will receive a notification every time a customer pays you for an order.
to check the payment status.
Is this integration guide useful?
ON THIS PAGE