1. Build Integration
Steps to integrate your Razorpay iOS Standard SDK with Razorpay Payment Gateway.
Steps to integrate the Razorpay iOS Standard SDK are given below:
1.1
.1.2
.1.3
.1.4
.- .
- .
1.5
.1.6
.1.7
.1.8
.You can import the Razorpay iOS Standard SDK library using any of these ways:
- Cocoapod
- Manual
- Objective-C.
Refer to our
(bitcode enabled) pod.- Download the SDK and unzip it.
- Open your project in XCode and go to file under Menu. Select Add files to "yourproject".
- Select Razorpay.xcframework in the directory you just unzipped.
- Select the Copy items if needed checkbox.
- Click Add.
- Navigate to Target settings → General and add the Razorpay.xcframework in both Embedded Binaries and Linked Frameworks and Libraries.
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 initialize Razorpay iOS Standard SDK, you need the following:
-
API keys. You can generate this from the
.Watch Out!
API keys should not be hardcoded in the app. Must be sent from your backend as app-related metadata fetch.
-
A delegate that implements
RazorpayPaymentCompletionProtocol
orRazorpayPaymentCompletionProtocolWithData
.
Watch Out!
- For Swift version 5.1+, ensure that you 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 {// typealias Razorpay = RazorpayCheckoutvar razorpay: RazorpayCheckout!override func viewDidLoad() {super.viewDidLoad()razorpay = RazorpayCheckout.initWithKey(razorpayTestKey, andDelegate: self)}override func viewWillAppear(_ animated: Bool) {super.viewWillAppear(animated)self.showPaymentForm()}}
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
.Call RazorpayCheckout.checkIntegration(withMerchantKey: <merchant_key>)
to check the health of integration. This will also let you know if the SDK version is outdated. The opinionated alerting is displayed only when it is running on simulators.
Add the following code to your ViewController
or wherever you want to initialize payments:
internal func showPaymentForm(){let options: [String:Any] = ["key": "YOUR_KEY_ID","amount": "100", //This is in currency subunits. 100 = 100 paise= INR 1."currency": "INR",//We support more that 92 international currencies."description": "purchase description","order_id": "order_DBJOWzybf0sJbb","image": "https://url-to-image.jpg","name": "business or product name","prefill": ["contact": "9797979797","email": "foo@bar.com"],"theme": ["color": "#F37254"]]razorpay.open(options)}
Optional Parameter - displayController
When the optional parameter- displayController, is specified, the Razorpay controller is pushed onto this controller's navigation controller if present or presented on this controller if absent.
razorpay.open(options, displayController: self)
You must pass these parameters in Checkout to initiate the payment.
key
mandatory
string
API Key ID generated from the Razorpay Dashboard.
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 payment should be made by the customer. 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).name
mandatory
string
Your Business/Enterprise name shown on the Checkout form. For example, Acme Corp.
description
optional
string
Description of the purchase item shown on the Checkout form. It should start with an alphanumeric character.
image
optional
string
Link to an image (usually your business logo) shown on the Checkout form. Can also be a base64 string if you are not loading the image from a network.
order_id
mandatory
string
Order ID generated via
prefill
object
You can prefill the following details at Checkout.
Boost Conversions and Minimise Drop-offs
- Autofill customer contact details, especially phone number to ease form completion. Include customer’s phone number in the
contact
parameter of the JSON request'sprefill
object. Format: +(country code)(phone number). Example: “contact": "+919000090000"). - This is not applicable if you do not collect customer contact details on your website before checkout, have Shopify stores or use any of the no-code apps.
name
optional
string
Cardholder's name to be pre-filled if customer is to make card payments on Checkout. For example, Gaurav Kumar.
optional
string
Email address of the customer.
contact
optional
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.
method
optional
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
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).
theme
object
Thematic options to modify the appearance of Checkout.
hide_topbar
optional
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:
true
: Hides the top barfalse
(default): Displays the top bar.
color
optional
string
Enter your brand colour's HEX code to alter the text, payment method icons and CTA (call-to-action) button colour of the Checkout form.
backdrop_color
optional
string
Enter a HEX code to change the Checkout's backdrop colour.
modal
object
Options to handle the Checkout modal.
backdropclose
optional
boolean
Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values:
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.
escape
optional
boolean
Indicates whether pressing the escape key should close the Checkout form. Possible values:
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.
handleback
optional
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_close
optional
boolean
Determines whether a confirmation dialog box should be shown if customers attempts to close Checkout. Possible values:
true
: Confirmation dialog box is shown.false
(default): Confirmation dialog box is not shown.
ondismiss
optional
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.
animation
optional
boolean
Shows an animation before loading of Checkout. Possible values:
true
(default): Animation appears.false
: Animation does not appear.
subscription_id
optional
string
If you are accepting recurring payments using Razorpay Checkout, you should pass the relevant subscription_id
to the Checkout. Know more about
subscription_card_change
optional
boolean
Permit or restrict customer from changing the card linked to the subscription. You can also do this from the
true
: Allow the customer to change the card from Checkout.false
(default): Do not allow the customer to change the card from Checkout.
recurring
optional
boolean
Determines if you are accepting
true
: You are accepting recurring payments.false
(default): You are not accepting recurring payments.
callback_url
optional
string
Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is allowlisted.
redirect
optional
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 with the suggested next best option.
customer_id
optional
string
Unique identifier of customer. Used for:
- .
- Static bank account details on Checkout in case of .
remember_customer
optional
boolean
Determines whether to allow saving of cards. Can also be configured via the
true
: Enables card saving feature.false
(default): Disables card saving feature.
timeout
optional
integer
Sets a timeout on Checkout, in seconds. After the specified time limit, the customer will not be able to use Checkout.
readonly
object
Marks fields as read-only.
contact
optional
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.
optional
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.
name
optional
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.
hidden
object
Hides the contact details.
contact
optional
boolean
Used to set the contact
field as optional. Possible values:
true
: Customer will not be able to view this field.false
(default): Customer will be able to view this field.
optional
boolean
Used to set the email
field as optional. Possible values:
true
: Customer will not be able to view this field.false
(default): Customer will be able to view this field.
send_sms_hash
optional
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_rotation
optional
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.
retry
optional
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. We recommend you to set this to 4. Having a larger number here can cause loops to occur.
Watch Out!
Web Integration does not support the max_count
parameter. It is applicable only in Android and iOS SDKs.
config
optional
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:
en
: Englishben
: Bengalihi
: Hindimar
: Marathiguj
: Gujaratitam
: Tamiltel
: Telugu
Watch Out!
To support theme colour in the progress bar, please pass HEX colour values only.
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><string>credpay</string><string>mobikwik</string><string>freecharge</string><string>in.fampay.app</string><string>bhim</string><string>amazonpay</string><string>navi</string><string>kiwi</string><string>payzapp</string><string>jupiter</string><string>omnicard</string><string>icici</string><string>popclubapp</string><string>sbiyono</string><string>myjio</string><string>slice</string><string>bobupi</string><string>shriramone</string><string>indusmobile</string><string>whatsapp</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.]
After completing payment, you can handle success or error events by implementing onPaymentSuccess
and onPaymentError
methods of the RazorpayPaymentCompletionProtocol
.
Alternatively, you can implement onPaymentSuccess
and onPaymentError
methods of RazorpayPaymentCompletionProtocolWithData
.
extension CheckoutViewController : RazorpayPaymentCompletionProtocol {func onPaymentError(_ code: Int32, description str: String) {print("error: ", code, str)self.presentAlert(withTitle: "Alert", message: str)}func onPaymentSuccess(_ payment_id: String) {print("success: ", payment_id)self.presentAlert(withTitle: "Success", message: "Payment Succeeded")}}
extension CheckoutViewController: RazorpayPaymentCompletionProtocolWithData {func onPaymentError(_ code: Int32, description str: String, andData response: [AnyHashable : Any]?) {print("error: ", code)self.presentAlert(withTitle: "Alert", message: str)}func onPaymentSuccess(_ payment_id: String, andData response: [AnyHashable : Any]?) {print("success: ", payment_id)self.presentAlert(withTitle: "Success", message: "Payment Succeeded")}}
After completing the payment, add necessary actions based on success or error events.
Failure Codes:
- 0: Network error
- 1: Initialization failure / Unexpected behaviour
- 2: Payment cancelled by the user
Success handler receives payment_id
that you can use later for capturing 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
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