API ReferenceIntegrationsKnowledge Base

iOS SDK Integration - Razorpay Standard Checkout

Integrate the Razorpay Payment Gateway with your iOS app and start accepting payments from your customers.

Note:
We have moved our SDK to Swift framework. This framework only supports iOS version 10.0 and later. Public contracts have not been changed.

Following is the latest version of our framework:

SDK

Framework Compiled With

Download Link

CocoaPod

Razorpay Standard SDK 1.2.7

Swift 5.1+

Click here.

pod 'razorpay-pod', '~> 1.1.7'

Razorpay Standard SDK 1.1.1

Swift 5.0

Click here.

pod 'razorpay-pod', '~> 1.1.1'

Razorpay Standard SDK 1.0.26

Swift 4.2

Click here.

pod 'razorpay-pod', '~> 1.0.26'

Razorpay Standard SDK 1.0.8

Swift 4.0

Click here.

pod 'razorpay-pod', '~> 1.0.8'

Video Tutorial#

Watch this video to learn how to integrate Razorpay Payment Gateway on your iOS app.

Prerequisites#

  • Learn about the Razorpay Payment Flow.
  • Sign up for a Razorpay Account and generate the API Keys from the Razorpay Dashboard. Using the Test keys helps simulate a sandbox environment. No actual monetary transaction happens when using the Test keys. Use Live keys once you have thoroughly tested the application and are ready to go live.

Integration Steps#

Steps to integrate the Razorpay iOS Standard SDK are given below:

Post-Integration Steps:
Once you have successfully completed the integration, you can setup webhooks, make test payments, replace test key with live key and integrate with other APIs. Refer to the post-integration section for more details.

Step 1: Import the Razorpay iOS Standard SDK Library#

You can import the SDK: - Using CocoaPod - Manually

Cocoapod#

Refer to our Cocoapod (bitcode enabled) pod.

Manual#

  1. Download the SDK and unzip it.
  2. Open your project in XCode and go to file under Menu. Select Add files to "yourproject".
  3. Select Razorpay.xcframework in the directory you just unzipped.
  4. Select the Copy items if needed check-box.
  5. Click Add.
  6. Navigate to Target settings > General and add the Razorpay.xcframework in both Embedded Binaries and Linked Frameworks and Libraries.

Objective-C:#

If you are building an Objective-C project, follow the steps given for Swift and the additional steps given below:

  1. Go to Project Settings and select Build Settings - All and Combined.
  2. 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.

For Xcode 11, 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'.

Step 2: Initialize the Razorpay iOS Standard SDK#

To initialize the Razorpay iOS Standard SDK, you need the following:

  • API keys. You can generate this from the Razorpay Dashboard.

    Note:
    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 or RazorpayPaymentCompletionProtocolWithData.

Use Variable RazorpayCheckout for Swift versions 5.1+:
For Swift version 5.1+, ensure that you declare var razorpay: RazorpayCheckout!. For versions lower than 5.1, you may use var razorpay: Razorpay!.

Alternatively, you can use the following alias and retain the variable as Razorpay.

typealias Razorpay = RazorpayCheckout

Copy import Razorpay class ViewController: UIViewController, RazorpayPaymentCompletionProtocol { // typealias Razorpay = RazorpayCheckout var razorpay: RazorpayCheckout! override func viewDidLoad() { super.viewDidLoad() razorpay = RazorpayCheckout.initWithKey(razorpayTestKey, andDelegate: self) } override func viewDidAppear(_ animated: Bool) { super.viewDidAppear(animated) self.showPaymentForm() } }
Copy#import <Razorpay/Razorpay.h> //- typedef RazorpayCheckout Razorpay; @interface ViewController () <RazorpayPaymentCompletionProtocol> { RazorpayCheckout *razorpay; . . - (void)viewDidLoad { [super viewDidLoad]; . . razorpay = [RazorpayCheckout initWithKey:@"YOUR_PUBLIC_KEY" andDelegate:self]; } }

Step 3: Create an Order in Server#

Create an Order in your server using the Orders API.

Orders API helps to prevent multiple payments by binding a single successful payment to an order.

Sample Code#

The following is a sample API request and response for creating an order:

Copycurl -X POST https://api.razorpay.com/v1/orders -H 'content-type:application/json' -d '{ "amount": 50000, "currency": "INR", "receipt": "rcptid_11" }'
Copytry { JSONObject orderRequest = new JSONObject(); orderRequest.put("amount", 50000); // amount in the smallest currency unit orderRequest.put("currency", "INR"); orderRequest.put("receipt", "order_rcptid_11"); Order order = razorpay.Orders.create(orderRequest); } catch (RazorpayException e) { // Handle Exception System.out.println(e.getMessage()); }
Copyorder_amount = 50000 order_currency = 'INR' order_receipt = 'order_rcptid_11' notes = {'Shipping address': 'Bommanahalli, Bangalore'} # OPTIONAL client.order.create(amount=order_amount, currency=order_currency, receipt=order_receipt, notes=notes)
Copy$order = $client->order->create([ 'receipt' => 'order_rcptid_11', 'amount' => 50000, // amount in the smallest currency unit 'currency' => 'INR'// <a href="/docs/international-payments/#supported-currencies" target="_blank">See the list of supported currencies</a>.) ]);
CopyDictionary<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);
Copyoptions = amount: 50000, currency: 'INR', receipt: '<order_rcptid_11>' order = Razorpay::Order.create
Copyvar options = { amount: 50000, // amount in the smallest currency unit currency: "INR", receipt: "order_rcptid_11" }; instance.orders.create(options, function(err, order) { console.log(order); });
Copy{ "id": "order_DBJOWzybf0sJbb", "entity": "order", "amount": 50000, "amount_paid": 0, "amount_due": 50000, "currency": "INR", "receipt": "rcptid_11", "status": "created", "attempts": 0, "notes": [], "created_at": 1566986570 }

Parameters#

Here is the list of parameters for creating the order:

amount mandatory
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.
currency mandatory
string The currency in which the transaction should be made. See the list of supported currencies.
receipt optional
string Your receipt id for this order should be passed here. Maximum length 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”.

A successful creation of the Order returns the order_id that you need to store against the Order defined in your system.

Step 4: Pass Payment Options and Display Checkout Form#

Add the following code to your ViewController or wherever you want to initialize payments:

Copyinternal func showPaymentForm(){ let options: [String:Any] = [ "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.png", "name": "business or product name", "prefill": [ "contact": "9797979797", "email": "foo@bar.com" ], "theme": [ "color": "#F37254" ] ] razorpay.open(options) }
Copy- (void)showPaymentForm { // called by your app NSDictionary *options = @{ @"amount": @"1000", //This is in currency subunits. 1000 = 1000 paise= INR 10. // all optional other than amount. @"currency": @"INR", //We support more that 92 international currencies. @"image": @"https://url-to-image.png", @"name": @"business or product name", @"description": @"purchase description", @"order_id": @"order_4xbQrmEoA5WJ0G", @"prefill" : @{ @"email": @"foo@bar.com", @"contact": @"9797979797" }, @"theme": @{ @"color": @"#F37254" } }; [razorpay open:options]; }

NOTE:
We now support another optional parameter to the open method - displayController. When this parameter is specified, the Razorpay controller is pushed on to this controller's navigation controller if present or presented on this controller if absent.
For example the Swift call is:
razorpay.open(options, displayController: self)

Other Checkout form fields#

Refer to the Checkout form documentation for the list of all supported Checkout form options.

Progress Bar:
To support theme color in progress bar, please pass HEX color values only.

Enable UPI Intent on iOS#

Provide your customers 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 their 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.

Copy<key>LSApplicationQueriesSchemes</key> <array> <string>tez</string> <string>phonepe</string> <string>paytmmp</string> </array>

Read More: Learn more about UPI Intent and its benefits.

Step 5: Handle Success and Errors Events#

You can handle success or error events when a payment is completed by implementing onPaymentSuccess and onPaymentError methods of the RazorpayPaymentCompletionProtocol.

Alternatively, you can implement onPaymentSuccess and onPaymentError methods of RazorpayPaymentCompletionProtocolWithData.

Copypublic func onPaymentError(_ code: Int32, description str: String){ let alertController = UIAlertController(title: "FAILURE", message: str, preferredStyle: .alert) let cancelAction = UIAlertAction(title: "OK", style: .cancel, handler: nil) alertController.addAction(cancelAction) self.view.window?.rootViewController?.present(alertController, animated: true, completion: nil) } public func onPaymentSuccess(_ payment_id: String){ let alertController = UIAlertController(title: "SUCCESS", message: "Payment Id \(payment_id)", preferredStyle: .alert) let cancelAction = UIAlertAction(title: "OK", style: .cancel, handler: nil) alertController.addAction(cancelAction) self.view.window?.rootViewController?.present(alertController, animated: true, completion: nil) }
Copy- (void)onPaymentSuccess:(nonnull NSString*)payment_id { [[[UIAlertView alloc] initWithTitle:@"Payment Successful" message:payment_id delegate:self cancelButtonTitle:@"OK" otherButtonTitles:nil] show]; } - (void)onPaymentError:(int)code description:(nonnull NSString *)str { [[[UIAlertView alloc] initWithTitle:@"Error" message:str delegate:self cancelButtonTitle:@"OK" otherButtonTitles:nil] show]; }

Here you have to add necessary actions after the payment is completed based on success or error events.

Possible values for failure code are:

  • 0: Network error
  • 1: Initialization failure / Unexpected behavior
  • 2: Payment cancelled by user

Success handler receives payment_id that you can use later for capturing the payment.

Step 6: Store the Fields in Database#

A successful payment returns the following fields to the Checkout Form. Make provisions to store these fields on your server. You can confirm the authenticity of these details by verifying the signature in the next step.

Copy{ "razorpay_payment_id": "pay_29QQoUBi66xm2f", "razorpay_order_id": "order_9A33XWu170gUtm", "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d" }
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.

Step 7: Verify Payment with Signature Verification#

This is a mandatory step that allows you 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:

  1. 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 Dashboard.
  2. 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 }
  3. 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.

Generate Signature on your Server#

Copy/** * This class defines common routines for generating * authentication signatures for Razorpay Webhook requests. */ public class Signature { private static final String HMAC_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 */ public static String calculateRFC2104HMAC(String data, String secret) throws java.security.SignatureException { String result; try { // get an hmac_sha256 key from the raw secret bytes SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM); // get an hmac_sha256 Mac instance and initialize with the signing key Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM); mac.init(signingKey); // compute the hmac on input data bytes byte[] rawHmac = mac.doFinal(data.getBytes()); // base64-encode the hmac result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase(); } catch (Exception e) { throw new SignatureException("Failed to generate HMAC : " + e.getMessage()); } return result; } }
Copyuse Razorpay\Api\Api; $api = new Api($key_id, $key_secret); $attributes = array('razorpay_signature' => '23233', 'razorpay_payment_id' => '332' , 'order_id' => '12122'); $order = $api->utility->verifyPaymentSignature($attributes)
Copyrequire 'razorpay' Razorpay.setup('key_id', 'key_secret') payment_response = { 'order_id': '12122', 'razorpay_payment_id': '332', 'razorpay_signature': '23233' } Razorpay::Utility.verify_payment_signature(payment_response)
Copyimport razorpay client = razorpay.Client(auth = ('<key_id>', '<key_secret>')) params_dict = { 'order_id': '12122', 'razorpay_payment_id': '332', 'razorpay_signature': '23233' } client.utility.verify_payment_signature(params_dict)

Post Signature Verification#

After verifying the signature, fetch the order in your system that corresponds to the razorpay_order_id in your database. Mark it as successful and process the order.

iOS 9 Update:

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:

Copy<key>NSAppTransportSecurity</key> <dict> <key>NSAllowsArbitraryLoads</key> <true/> </dict>

Add the above to your info.plist file. For more information click here.

Make a Test Payment#

  1. Go to your website and start a transaction with click the Pay With Razorpay button.
  2. Make the payment. Since this is a test payment, no money is actually deducted from your bank account or cards.
  3. The transaction is reflected in Dashboard → Transactions → Payments in captured state. This means that the transaction was successful.

Switch to Live Mode#

Once you have successfully integrated and tested it out, you can switch to the live mode. You can do this by replacing the Test API Key with the Live Key. You can generate the Live Key from the Dashboard.

Integrate the APIs#

Once the integration is complete, the next thing to do is to integrate APIs for:

  • Payments

    • Retrieve information regarding automatically captured Payments
    • Capture Payments manually
  • Settlements

    • Retrieve information regarding Settlements
  • Refunds

    • Initiate Refunds
    • Retrieve information regarding Refunds

Timeouts#

The transaction timeout is applicable only when your customer attempts the payment.

The timeout is 3 to 15 minutes for an attempted payment. If there is a payment failure due to timeout, the customer is redirected to the Checkout page.

Test the Integration#

Now that the integration is complete, you must ensure that your integration works as expected. You can make a test transaction using the test cards, verify the payment status from Dashboard, APIs or subscribe to related Webhook events to take appropriate actions at your end. After testing the integration in test mode, you can start accepting payments from your customers in real-time.

Test Payments#

You can make test payments using any of the payment methods configured on the Checkout. No money is deducted from the customer's account as this is a simulated transaction. In the Checkout code, ensure that you have entered the API keys generated in the test mode.

Test Cards#

You can use any of the test cards to make transactions in the test mode. Use any valid expiration date in the future and any random CVV to create a successful payment.

Card Network

Domestic / International

Card Number

Mastercard

Domestic

5104 0155 5555 5558
5104 0600 0000 0008

Visa

Domestic

4111 1111 1111 1111

Mastercard

International

5555 5555 5555 4444
5105 1051 0510 5100

Visa

International

4012 8888 8888 1881
4000 1841 8621 8826

Verify the Payment Status#

You can track the status of the payment from the Dashboard or subscribe to the Webhook event or poll our APIs.

From the Dashboard#

  1. Log into your Dashboard and navigate to TransactionsPayments.
  2. Look if a payment_ID has been generated. If no payment_ID has been generated, it means that the transaction has failed.

Subscribe to Webhook events#

You can subscribe to a Webhook event that is generated when a certain event happens in our server. When one of those events is triggered, Razorpay sends the Webhook payload to the configured URL.

Learn how to set up Webhooks.

When the customer makes a successful payment on the Checkout, payment.authorized event is created in Razorpay.

Poll APIs#

You can retrieve the status of the payments by polling our Payment APIs.

Accept Live Payments#

After testing the flow of funds end-to-end in test mode, you are now ready to take your integration live. Once you are confident that the integration is working fine, you can switch to the live mode and start accepting payments from customers. But first, you need to swap the test API keys with the live keys.

To generate API key in live mode:

  1. Log into Dashboard and switch to Live mode on the menu.
  2. Navigate to SettingsAPI KeysGenerate Key to generate API key for live mode.
  3. Download the keys and save it securely.
  4. Replace the test API key with the Live Key in the Checkout code and start accepting real-time payments.