1. Build Integration
Steps to integrate your Razorpay iOS Custom SDK with Razorpay Payment Gateway.
Follow the steps to integrate the Razorpay iOS Custom SDK:
1.1
.1.2
.1.3
.1.4
.1.5
.1.6
.1.7
.1.8
.1.9
.1.10
.You can import the Razorpay iOS Custom SDK library using any of these ways: Cocoapod, Manual and Objective-C.
Refer to our
pod.- Download the file and unzip the SDK attachment.
- Open your project in XCode and go to file under Menu and select Add files to "yourproject".
- Select Razorpay.xcframework in the directory you just unzipped.
- Click on the Copy items if needed checkbox.
- Click Add.
Ensure that you have the framework added in both Embedded Binaries and Linked Frameworks and Libraries under Target settings - General.
If you are building an Objective-C project, follow the steps given for Swift and the additional steps given below:
- Go to Project Settings and select Build Settings - All and Combined.
- Set the Always Embed Swift Standard Libraries option to TRUE.
Ensure that you have the framework added in both Embedded Binaries and Linked Frameworks and Libraries under Target settings - General.
Ensure that you have the framework added in Frameworks, Libraries, and Embed Content under Target settings - General. Change Embed status
from - Do not Embed
to Embed & Sign
.
Watch the GIF to see how to add Frameworks, Libraries and Embed Content.
To initialise the Razorpay SDK:
-
API key. You can generate this from the
.Watch Out!
API keys should not be hardcoded in the app. They must be sent from your backend as app-related metadata fetch.
-
A delegate that implements
RazorpayPaymentCompletionProtocol
andWKNavigationDelegate
-
A
WKWebView
to show the bank pages
Watch Out!
-
For Swift version 5.1+, ensure to declare
var razorpay: RazorpayCheckout!
. -
For versions lower than 5.1, use
var razorpay: Razorpay!
. -
Alternatively, you can use the following alias and retain the variable as Razorpay.
typealias Razorpay = RazorpayCheckout
import Razorpayclass ViewController: UIViewController, RazorpayPaymentCompletionProtocol, WKNavigationDelegate {// typealias Razorpay = RazorpayCheckoutvar webView: WKWebView!var razorpay: RazorpayCheckout!..override func viewDidLoad() {super.viewDidLoad()self.webView = WKWebView(frame: self.view.frame)self.razorpay = RazorpayCheckout.initWithKey("Key", andDelegate: self, withPaymentWebView: self.webView)self.view.addSubview(self.webView)}}
Initialise the Razorpay SDK only with API Key
To render your UI based on the available payment methods, initialise the Razorpay SDK only with the API key and call
.self.razorpay = RazorpayCheckout.initWithKey("KEY")
To use the SDK initialisation mentioned above, call the following method using the previously created Razorpay instance on any other page where you wish to initiate the payment through the authorise method.
do {try self.razorpay?.setWebView(self.wkWebView)try self.razorpay?.setDelegate(self)} catch {print(error.localizedDescription)}
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.
You can create an order:
- Using the sample code on the Razorpay Postman Public Workspace.
- By manually integrating the API sample codes on your server.
You can use the Postman workspace below to create an order:
Handy Tips
Under the Authorization section in Postman, select Basic Auth and add the Key Id and secret as the Username and Password, respectively.
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": 500,"currency": "INR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230,"notes": {"key1": "value3","key2": "value2"}}'
{"id": "order_IluGWxBm9U8zJ8","entity": "order","amount": 5000,"amount_paid": 0,"amount_due": 5000,"currency": "INR","receipt": "rcptid_11","offer_id": null,"status": "created","attempts": 0,"notes": [],"created_at": 1642662092}
amount
mandatory
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299.00, then pass 29900
in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
Watch Out!
As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to charge a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990
and not 99991
.
currency
mandatory
string
The currency in which the transaction should be made. See the
Handy Tips
Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about
(May 2024).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 ₹7,000.00 is to be received from the customer in two installments of #1 - ₹5,000.00, #2 - ₹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 UPI, credit/debit cards, netbanking and wallets, depending on the methods enabled for your account. When you use
, you do not have to handle the availability of different payment methods. However, when creating a custom checkout form, ensure the display of only the methods activated for your account to the customer.To get a list of available payment methods, call getPaymentMethods
. This fetches the list of payment methods asynchronously and returns the results.
self.razorpay.getPaymentMethods(withOptions: nil, withSuccessCallback: {methods inpaymentMethods = methods}){ error inerrorDescription = error}
If you use your iOS app to receive subscription payments, you must pass the subscription_id
in options
to fetch the relevant payment methods. This is because Subscription payments are supported only by select banks and cards.
let options :[String:String] = ["subscription_id": "sub_testid"] \\ For subscriptionsvar paymentMethods :[AnyHashable:Any] = [:]var errorDescription: String = ""self.razorpay.getPaymentMethods(withOptions: options, withSuccessCallback: {methods inpaymentMethods = methods}){ error inerrorDescription = error}
You can get the subscription amount against the subscription ID using the following function:
var errorDescription: String = ""var amount: UInt64 = 0self.razorpay.getSubscriptionAmount(havingSubscriptionId: "sub_testid", withSuccessCallback: {subAmount inamount = subAmount}){ error inerrorDescription = error}
Once you receive the required input from the customer, pass them to our SDK, which takes them to the appropriate authentication channel.
Add the following code where you want to initiate payment:
let options: [String:Any] = ["amount": 100, // amount in currency subunits. Defaults to INR. 100 = 100 paise = INR 1. We support more than 92 currencies."currency": "INR",//We support more that 92 international currencies."email": "gaurav.kumar@example.com","contact": "9090980808","order_id": "order_DBJOWzybf0sJbb",//From response of Step 3"method": "card","card[name]": "Gaurav Kumar","card[number]": "4111111111111111","card[expiry_month]": 06,"card[expiry_year]": 30,"card[cvv]": "123"]razorpay.authorize(options)
For UPI collect requests, use the following dictionary and pass it to the authorize
function as shown below:
let options: [AnyHashable:Any] = ["amount": "100", // amount in paise"currency": "INR","email": "a@b.com","contact": "1234567890","method":"upi","vpa":"test@axisbank"]self.razorpay?.authorize(options)
Here, razorpay
is an instance of Razorpay.
Handy Tips
As per NPCI guidelines, we have applied the following restrictions to the UPI Collect flow.
- MCC 6540: UPI Collect flow is not available for this MCC. You can use as an alternative.
- MCC 4812: Maximum amount limited to ₹5,000 per transaction for UPI Collect flow. You can use as an alternative.
- MCC 4814: Maximum amount limited to ₹5,000 per transaction for UPI Collect flow. You can use as an alternative.
Below is a complete list of Checkout form parameters:
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
. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
Watch Out!
As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to charge a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990
and not 99991
.
currency
mandatory
string
The currency in which the payment should be made by the customer. For example, INR
. See the list of
Handy Tips
Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about
(May 2024).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 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.
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
Handy Tips
- The
notes
field is a read-only field associated with payment and is returned while fetching payment details. Razorpay cannot modify this field. You can add up to 15notes
that will then be associated with the payment. For example:"notes[internal_key_1]", "notes[internal_key_2]")
. Razorpay returns this when you fetch payment details from the API. - The
emi
option is available only for certain banks. To check the right banks, valid duration and EMI rates/plans to display to the user, please visit the page and click EMI in the payment form. You can safely cache this data at your end since this does not change without prior notification. Calculate the monthly EMI or cache using the following formula:
SDK handles the responses from WKWebView to give you the correct status of the payment.
override func viewDidLoad() {super.viewDidLoad()..self.webView.navigationDelegate = self}public func webView(_ webView: WKWebView, didCommit navigation: WKNavigation!){if razorpay != nil{self.razorpay.webView(webView, didCommit: navigation)}}public func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError er: Error) {if razorpay != nil{self.razorpay.webView(webView, didFailProvisionalNavigation: navigation, withError: er)}}public func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError er: Error){if razorpay != nil{self.razorpay.webView(webView, didFail: navigation, withError: er)}}public func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!){if razorpay != nil{self.razorpay.webView(webView, didFinish: navigation)}}
This is done by implementing the onPaymentSuccess
and onPaymentError
methods of the RazorpayPaymentCompletionProtocol
.
We recommend giving the user an option to cancel the payment midway and pass on this action. You may also implement a retry action or display a relevant message at this step based on your use case.
func onPaymentError(_ code: Int32, description str: String, andData response: [AnyHashable : Any]){let alertController = UIAlertController(title: "FAILURE", message: str, preferredStyle: UIAlertControllerStyle.alert)let cancelAction = UIAlertAction(title: "OK", style: UIAlertActionStyle.cancel, handler: nil)alertController.addAction(cancelAction)//self.view = view that controller managesself.view.sendSubview(toBack: self.webView)navBar.isHidden = truenavBar.isUserInteractionEnabled = falseself.view.window?.rootViewController?.present(alertController, animated: true, completion: nil)self.razorpay = nil}func onPaymentSuccess(_ payment_id: String, andData response: [AnyHashable : Any]){let alertController = UIAlertController(title: "SUCCESS", message: "Payment Id \(payment_id)", preferredStyle: UIAlertControllerStyle.alert)let cancelAction = UIAlertAction(title: "OK", style: UIAlertActionStyle.cancel, handler: nil)alertController.addAction(cancelAction)//self.view = view that controller managesself.view.sendSubview(toBack: self.webView)navBar.isHidden = truenavBar.isUserInteractionEnabled = falseself.view.window?.rootViewController?.present(alertController, animated: true, completion: nil)self.razorpay = nil}//MARK: Action functions@IBAction func cancel(_ sender: Any){let alertController = UIAlertController(title: "Cancel Transaction", message: "Are you sure you want to cancel the current transaction ? The page will go back to the checkout page, where you can choose another payment option", preferredStyle: UIAlertControllerStyle.alert)let cancelAction = UIAlertAction(title: "Do Not Cancel", style: UIAlertActionStyle.cancel, handler: nil)let okayAction = UIAlertAction(title: "Cancel", style: UIAlertActionStyle.destructive, handler: { action inself.razorpay.userCancelledPayment()} )alertController.addAction(cancelAction)alertController.addAction(okayAction)self.view.window?.rootViewController?.present(alertController, animated: true, completion: nil)}
Success handler will receive payment_id
that you can use later to capture the payment.
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 .Handy Tips
iOS 9 has higher requirements for secure URLs. As many Indian banks do not comply with the requirements, you can implement the following as a workaround:
<key>NSAppTransportSecurity</key><dict><key>NSAllowsArbitraryLoads</key><true/></dict>
Add the above to your info.plist
file. For more information click
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?
ON THIS PAGE