1. Build Integration

Steps to integrate your Razorpay iOS Custom SDK with Curlec 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.

  1. Download the file and unzip the SDK attachment.
  2. Open your project in XCode and go to file under Menu and select Add files to "yourproject".
  3. Select Razorpay.xcframework in the directory you just unzipped.
  4. Click on the Copy items if needed checkbox.
  5. 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:

  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.

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 and WKNavigationDelegate

  • 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 Razorpay
class ViewController: UIViewController, RazorpayPaymentCompletionProtocol, WKNavigationDelegate {
// typealias Razorpay = RazorpayCheckout
var 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.

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

POST
/orders
curl -X POST https://api.razorpay.com/v1/orders
-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
"amount": 100,
"currency": "MYR",
"receipt": "qwsaq1",
"partial_payment": true,
"first_payment_min_amount": 230,
"notes": {
"key1": "value3",
"key2": "value2"
}
}'

Request Parameters

amount

mandatory

integer The transaction amount, expressed in the currency subunit, such as Ringgit (in case of MY). For example, for an actual amount of RM 299.35 , the value of this field should be 29935.

currency

mandatory

string The currency in which the transaction should be made. Length must be of 3 characters. For example, MYR.

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 RM 7,000.00 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

parameters table.

Error Response Parameters

The error response parameters are available in the

.

You can accept payments through wallets, FPX, credit and debit cards 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 in
paymentMethods = methods
}){ error in
errorDescription = 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.
"currency": "MYR",//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]": "5272008806235704",
"card[expiry_month]": 06,
"card[expiry_year]": 30,
"card[cvv]": "123"
]
razorpay.authorize(options)

Below is a complete list of Checkout form parameters:

key

mandatory

string API Key ID generated from DashboardAccount & Settings

.

amount

mandatory

integer The amount to be paid by the customer in currency subunits. For example, if the amount is RM 100.00, enter 10000.

currency

mandatory

string The currency in which the payment should be made by the customer. For example, MYR.

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

string The payment method used by the customer on Checkout.
Possible values:

  • card (default)
  • fpx (default)
  • wallet (default)

card

mandatory if method=card

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.

bank

mandatory if method=fpx

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:

  • touchngo (default)
  • grabpay (default)

callback_url

optional

string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted. 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 not redirected to the specified callback URL.

Handy Tips

  • The notes field is a read-only field associated with payment and is returned while fetching payment details. Curlec cannot modify this field. You can add up to 15 notes that will then be associated with the payment. For example: "notes[internal_key_1]", "notes[internal_key_2]"). Curlec returns this when you fetch payment details from the API.

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 manages
self.view.sendSubview(toBack: self.webView)
navBar.isHidden = true
navBar.isUserInteractionEnabled = false
self.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 manages
self.view.sendSubview(toBack: self.webView)
navBar.isHidden = true
navBar.isUserInteractionEnabled = false
self.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 in
self.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:

  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 .
  2. Use the SHA256 algorithm, the razorpay_payment_id and the order_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
    }
  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.

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 .

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:

  1. Log in to the and navigate to TransactionsPayments.
  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.
Check if the payment id is generated and the status is captured

You can use Curlec 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?