Integration Steps

Steps to integrate your iOS application with Razorpay iOS Standard SDK.

Follow these steps to integrate your iOS application:

1. Build Integration

Integrate iOS Standard Checkout.

2. Test Integration

Test the integration by making a test payment.

3. Go-live Checklist

Check the go-live checklist.

1. Build Integration

Follow the steps given below:

1 Import Razorpay iOS Standard SDK Library

You can import the Razorpay iOS Standard SDK library using any of these ways:

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 checkbox.
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.

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.
Watch the GIF to see how to add Frameworks, Libraries and Embed Content.

2 Initialize Razorpay iOS Standard SDK

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

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

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

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

ViewController.swift

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 viewWillAppear(_ animated: Bool) {
    super.viewWillAppear(animated)
            self.showPaymentForm()
    }
}

3 Create an Order in Server

Order is an important step in the payment process.

• An order should be created for every payment.
• You can create an order using the Orders API. It is a server-side API call. Know how to authenticate 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.

Watch Out!

Payments made without an order_id cannot be captured and will be automatically refunded. You must create an order before initiating payments to ensure proper payment processing.

API Sample Code

Use this endpoint to create an order using the Orders API.

POST /orders

Curl

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": "MYR",
    "receipt": "qwsaq1",
    "partial_payment": true,
    "first_payment_min_amount": 230
}'

Request Parameters

amount mandatory : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of , the value of this field should be 22225.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

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 is to be received from the customer in two installments of #1 - RM 5,000, #2 - RM 2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

Response Parameters

Descriptions for the response parameters are present in the Orders Entity parameters table.

Error Response Parameters

The error response parameters are available in the API Reference Guide.

4 Pass Payment Options and Display Checkout Form

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:

ViewController.swift

internal func showPaymentForm(){
    let options: [String:Any] = [
                "key": "YOUR_KEY_ID",
                "amount": "100", // This is in currency subunits. 
                "currency": "MYR",// We support more that 92 international currencies.
                "description": "purchase description",
                "order_id": "order_DBJOWzybf0sJbb",
                "image": "https://cdn.razorpay.com/logos/F9Yhfb7ZXjXmIQ_medium.jpg",
                "name": "business or product name",
                "prefill": [
                    "contact": "<phone>",
                    "email": "<email>"
                ],
                "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)

Checkout Options

You must pass these parameters in Checkout to initiate the payment.

key mandatory : string API Key ID generated from the Dashboard.

amount mandatory : integer The amount to be paid by the customer in sen. For example, if the amount is , enter 222250.

currency mandatory : string The currency in which the payment should be made by the customer. Length must be of 3 characters.

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 Orders API.

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’s prefill object. Format: +(country code)(phone number). Example: “contact”: “[phone]”.
• 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 prefilled if customer is to make card payments on Checkout. For example, Siti Aisyah.

email 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, 60 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside Malaysia. Examples:

• [phone] (a valid non-Malaysian number)
• [phone] (a valid Malaysian number).
  If 1113455567 is entered without the country code, +60 is added to it as [phone].

method optional : string Pre-selection of the payment method for the customer. Will only work if contact and email are also prefilled.
Possible value is card.

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.

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. If retry is false, the ondismiss function is triggered when checkout closes, even after a failure.

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 Subscriptions on Checkout.

subscription_card_change optional : 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.

callback_url optional : string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is allowlisted. This parameter is mandatory for FPX payments.

redirect optional : boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url and redirect parameters are mandatory for FPX payments. Possible values:

• true: Customer is redirected to the specified callback URL in case of payment failure. For FPX payments, the redirect parameter should always be sent as true.
• false (default): Customer is shown the Checkout popup to retry the payment.

customer_id optional : string Unique identifier of customer.

remember_customer optional : boolean Determines whether to allow saving of cards. Can also be configured via the Dashboard. Possible values:

• 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.

Watch Out!

Some browsers may pause JavaScript timers when the user switches tabs, especially in power saver mode. This can cause the checkout session to stay active beyond the set timeout duration.

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.

email 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.

email 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. 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.

config optional : object Parameters that enable checkout configuration. Know more about how to configure payment methods on Razorpay standard checkout.

display : object Child parameter that enables configuration of checkout display language.

language : string The language in which checkout should be displayed. Possible value is en: English.

Watch Out!

To support theme colour in the progress bar, please pass HEX colour values only.

5 Handle Success and Errors Events

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.

RazorpayPaymentCompletionProtocol

ViewController.swift

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")
    }
}

RazorpayPaymentCompletionProtocolWithData

ViewController.swift

 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.

6 Store the Fields in Database

A successful payment returns the following fields to the Checkout form.

Success Callback

• 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.

Success Callback

{
  "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.

7 Verify Payment Signature

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:

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:

HMAC Hex Digest

generated_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

Given below is the sample code for payment signature verification:

Java

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);

Post Signature Verification

After you have completed the integration, you can set up webhooks, make test payments, replace the test key with the live key and integrate with other APIs.

8 Verify Payment Status

Handy Tips

On the Razorpay Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to capture payments automatically.

You can track the payment status in three ways:

Verify Status from Dashboard

To verify the payment status from the Razorpay Dashboard:

1. Log in to the Razorpay Dashboard and navigate to Transactions → Payments.
2. Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

Subscribe to Webhook Events

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.

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order.

Poll APIs

Poll Payment APIs to check the payment status.

2. Test Integration

After the integration is complete, a Pay button appears on your webpage/app.

Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.

Watch Out!

This is a mock payment page that uses your test API keys, test card and payment details.

• Ensure you have entered only your Test Mode API keys in the Checkout code.
• Test mode features a mock bank page with Success and Failure buttons to replicate the live payment experience.
• No real money is deducted due to the usage of test API keys. This is a simulated transaction.

Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others may require approval from us. Raise a request from the Dashboard to enable such payment methods.

Payment Method	Code	Availability
Debit and Credit Cards	card	✓
FPX	fpx	✓
Wallets	wallet	✓

You can make test payments using one of the payment methods configured at the Checkout.

FPX

You can select any of the listed banks. After choosing a bank, Razorpay Curlec will redirect to a mock page where you can make the payment a success or a failure. Since this is Test Mode, we will not redirect you to the bank login portals.

Wallet

You can select any of the listed wallets. After choosing a wallet, you will be redirected to a mock page where you can make the payment success or a failure. Since this is Test Mode, we will not redirect you to the wallet login portals.

Watch Out!

iOS integration for Touch’n Go wallet is currently unavailable. We will be adding support for it soon.

Cards

You can use one of the following test cards to test transactions for your integration in Test Mode.

Card Network	Card Number	CVV & Expiry Date
Mastercard	5272 0088 0623 5704	Use a random CVV and any future date ^^
Visa	4842 7930 0208 6571

Check the following lists:

• Supported Card Networks.
• Cards Error Codes.

3. Go-live Checklist

Check the go-live checklist for Razorpay iOS integration. Consider these steps before taking the integration live.

1 Accept Live Payments

Perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.

Watch Out!

Ensure you are switching your test API keys with API keys generated in Live Mode.

To generate API Keys in Live Mode on your Razorpay Dashboard:

1. Log in to the Razorpay Dashboard and switch to Live Mode on the menu.
2. Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
3. Download the keys and save them securely.
4. Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.

2 Payment Capture

After payment is authorized, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.

Watch Out

• You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
• You can track the payment status using our Fetch a Payment API or webhooks.

Auto-capture Payments (Recommended)

Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard. Know more about capture settings for payments.

Watch Out!

Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the Orders API.

Manually Capture Payments

Each authorized payment can also be captured individually. You can manually capture payments using Payment Capture API or Dashboard. Know more about capture settings for payments.

3 Set Up Webhooks

Ensure you have set up webhooks in the live mode and configured the events for which you want to receive notifications.

Implementation Considerations

Webhooks are the primary and most efficient method for event notifications. They are delivered asynchronously in near real-time. For critical user-facing flows that need instant confirmation (like showing “Payment Successful” immediately), supplement webhooks with API verification.

Recommended approach

• Rely on webhooks for all automation, which can be asynchronous.
• If a critical user-facing flow requires instant status, but the webhook notification has not arrived within the time mandated by your business needs, perform an immediate API Fetch call (Payments, Orders and Refunds) to verify the status.