UPI Intent on iOS - S2S

Prerequisites

• Sign up for a Razorpay account.

• Generate API Keys

  from the Dashboard.

Workflow

To enable UPI Intent on your customer's iOS device:

1. Create an Order

   .
2. Update your iOS app's info.plist file
   .

3. Check availability of PSP app on customer's device

   .

4. Initiate Payment using the intent URL

   .

5. Deep link the URL by prefixing App Name

   .

6. Verify Payment Status

   .

Step 1: Create an Order

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.

Create an order by manually integrating the API sample codes on your server.

API Sample Code

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": 50000,
 "currency": "",
 "receipt": "qwsaq1",
 "partial_payment": true,
 "first_payment_min_amount": 230,
 "notes": {
   "key1": "value3",
   "key2": "value2"
 }
}'

{
 "id": "order_IluGWxBm9U8zJ8",
 "entity": "order",
 "amount": 50000,
 "amount_paid": 0,
 "amount_due": 50000,
 "currency": "",
 "receipt": "rcptid_11",
 "offer_id": null,
 "status": "created",
 "attempts": 0,
 "notes": [],
 "created_at": 1642662092
}

Step 2: Update your app's info.plist file

Your iOS app must seek permission from the device to open the UPI PSP app that the customer selects on Checkout. For this, you must make the following changes in your iOS 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>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-upi</string>
    <string>bobupi</string>
    <string>shriramone</string>
    <string>indusmobile</string>
    <string>whatsapp</string>
    <string>kotakbank</string>
</array>

Step 3: Check Availability of PSP App on Customer Device

You must ensure that the UPI PSP app (Google Pay, PhonePe or Paytm) is available on the customer's device. This can be done by checking the URI scheme.

If an app is not available, it will not be displayed on the Checkout. For example, if you want to determine availability of PhonePe on customer's device:

let urlPhonePe = "phonepe://" // This will open PhonePe URL.

if let urlString = urlPhonePe.addingPercentEncoding(withAllowedCharacters: NSCharacterSet.urlQueryAllowed) {
            if let phonepeURL = URL(string: urlString) {
                if UIApplication.shared.canOpenURL(phonepeURL) {
        //Show Phonepe image
                } else {
        // Hide Phonepe icon
                }
            }
        }

Step 4: Initiate the Payment

Request Parameters

Following are the request parameters:

Step 5: Deep link the URL by prefixing App Name

After the URL is generated in the response of the previous step, you should edit it and prefix the app name to the URL. For example, if you detect the presence of PhonePe on the customer's device, you should add a prefix to the URL as shown below:

For Google Pay and Paytm, you should append the prefix to the URL as shown:

Step 6: Verify Payment Status

You can subscribe to the order.paid, payment.authorized and payment.captured Webhook events to get notified once the customer completes the UPI payment. Know more about

You can also poll our APIs at regular intervals to track the status of the

Payment Failure and Re-initiating Payments

If the order is not marked paid within 2-3 minutes, you can re-initiate payment for the same order.