API ReferenceIntegrationsKnowledge Base

PhonePe Switch Integration

PhonePe Switch platform allows customers to switch seamlessly between PhonePe and their preferred apps within the PhonePe app itself. With a single tap, customers can log into these apps without downloading them. For example, customers can book cabs or hotel rooms right on the PhonePe app and utilize offers provided by PhonePe.

PhonePe enables various businesses to integrate their web apps or mobile sites with the Switch platform and instantly reach out to the PhonePe user base. By integrating Razorpay APIs with PhonePe Switch payment flow, you can accept in-app payments made by your customers without having to worry about handling settlements or reconciliation separately.

Handy Tips
This is an on-demand feature. Please raise a request with our support team to get this feature activated on your Razorpay account.

User Flow🔗

The user's journey through this entire flow is outlined below:

  1. Customers log into the PhonePe app and click PhonePe Switch.
  2. In the PhonePe Switch, customers select your app, place orders and click Proceed to Pay.
  3. Customers are redirected to the PhonePe payment page.
  4. After the successful payment on the PhonePe payment page, customers are redirected to your website.

For more details of the user journey through PhonePe Switch, refer to the PhonePe User flow documentation.

Prerequisites🔗

Before integrating with the Checkout, run through this checklist:

  • Check if your webapp is integrated with PhonePe Switch.

  • Understand the payment flow.

  • Sign up for a Razorpay Account.

  • Generate the API keys from the Dashboard. Use the test API Keys to test out the integration.

PCI DSS Certification:
A customer's payment information should never reach your servers, unless you are PCI DSS certified.

Integration Steps🔗

Steps to integrate Custom Checkout in your site:

  1. Create an Order from your Server.
  2. Invoke Checkout and Pass Order Id and Other Options to it
  3. Include the JavaScript code in your Webpage.
  4. Instantiate Razorpay Custom Checkout.
  5. Submit Payment Details.
  6. Store Fields in your Server.
  7. Verify the Signature.

Step 1: Create an Order in your Server🔗

When a customer places an order on your website or application, use the details to create an order on Razorpay.

/orders
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -X POST https://api.razorpay.com/v1/orders \ -H "Content-Type: application/json" \ -d '{ "amount": 1000, "currency": "INR", "receipt": "merchant_txn_id" "phonepe_switch_context" : "{\n\"orderContext\":{\"trackingInfo\":{\n\"type\":\"HTTPS\",\"url\":\"https://google.com\"}},\"fareDetails\":{\n\"payableAmount\":3900,\"totalAmount\":3900},\"cartDetails\":{\"cartItems\":[{\"quantity\":1,\"address\":{\"addressString\":\"TEST\",\"city\":\"TEST\",\"pincode\":\"TEST\",\"country\":\"TEST\",\n\"latitude\":1,\"longitude\":1},\"shippingInfo\":{\n\"deliveryType\":\"STANDARD\",\"time\":{\"timestamp\":1561540218,\"zoneOffSet\":\"+05:30\"\n\n\n}},\n\n\n\n\n\"category\":\"SHOPPING\",\"itemId\":\"1234567890\",\n\"price\":3900,\"itemName\":\"TEST\"}]}}" }'
Copy{ "id": "order_EdUtuxhupLSOUH", "entity": "order", "amount": 1000, "amount_paid": 0, "amount_due": 1000, "currency": "INR", "receipt": "merchant_txn_id", "offer_id": null, "status": "created", "attempts": 0, "notes": [], "created_at": 1586677700 }

Request Parameters🔗

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.
You can create Orders in INR only.
receipt optional
string Your receipt ID for this order can be passed here. Maximum length is 40 characters.
phonepe_switch_context optional
json string This is the transactionContext created by PhonePe. It contains the shopping cart details for the customer transacting on the PhonePe Switch platform. It is the transactionContext which is expected by PhonePe.
Refer to PhonePe transactionContext documentation.
notes optional
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”.

Step 2: Invoke Checkout and Pass Order Id and Other Options to it🔗

Step 2.1: Include the JavaScript code in your Webpage🔗

Include the following script, preferably in <head> section of your page:

Copy<script type="text/javascript" src="https://checkout.razorpay.com/v1/razorpay.js"></script>

Including the Javascript, not the Library:
Include the script from https://checkout.razorpay.com/v1/razorpay.js instead of serving a copy from your own server. This allows new updates and bug fixes to the library to get automatically served to your application.

We always maintain backward compatibility with our code.

Step 2.2: Instantiate Razorpay Custom Checkout🔗

Single Instance on a Page🔗

Copyvar razorpay = new Razorpay({ key: '<YOUR_KEY_ID>', // logo, displayed in the payment processing popup image: 'https://i.imgur.com/n5tjHFD.png', });

Multiple Instances on Same Page🔗

If you need multiple razorpay instances on same page, you can globally set some of the options:

CopyRazorpay.configure({ key: '<YOUR_KEY_ID>', // logo, displayed in the payment processing popup image: 'https://i.imgur.com/n5tjHFD.png', }) new Razorpay({}); // will inherit key and image from above.

Step 2.3: Submit Payment Details🔗

Once the order is created and the customer's payment details are obtained, the information should be sent to Razorpay to complete the payment. The data that needs to be submitted depends upon the payment method selected by the customer.

You can do this by invoking createPayment method:

Copy var data = { amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 currency: "INR", email: 'gaurav.kumar@example.com', contact: '9123456780', notes: { address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru', }, order_id: "order_EdUtuxhupLSOUH", // Enter the order ID obtained from Step 1 method: 'wallet', wallet: 'phonepeswitch' }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ razorpay.createPayment(data); razorpay.on('payment.success', function(resp){ alert(resp.razorpay_payment_id), alert(resp.razorpay_order_id), alert(resp.razorpay_signature) }); // will pass payment ID, order ID, and Razorpay signature to success handler. razorpay.on('payment.error', function(resp){ alert(resp.error.description)}); // will pass error object to error handler });
Copy var data = { callback_url: 'https://www.examplecallbackurl.com/', amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 currency: "INR", email: 'gaurav.kumar@example.com', contact: '9123456780', notes: { address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru', }, order_id: "order_EdUtuxhupLSOUH", // Enter the order ID obtained from Step 1 method: 'wallet', wallet: 'phonepeswitch' }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ razorpay.createPayment(data); });

Note:
The createPayment method should be called within an event listener triggered by user action to prevent the popup from being blocked. For example:
js $('button').click( function (){ razorpay.createPayment(...) })

Handler Function vs Callback URL:

  • Handler Function:
    When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server.
  • Callback URL:
    When you use a Callback URL, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Callback URL.

Step 3: Store Fields in your Server🔗

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 4: Verify the Signature🔗

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 Razorpay 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🔗

The links to the Razorpay SDKs for the supported platforms are given below:

Platform

Link

Java

https://github.com/razorpay/razorpay-java

PHP

https://github.com/razorpay/razorpay-php

Ruby

https://github.com/razorpay/razorpay-ruby

Python

https://github.com/razorpay/razorpay-python

.Net

https://github.com/razorpay/razorpay-dot-net

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' , 'razorpay_order_id' => '12122'); $order = $api->utility->verifyPaymentSignature($attributes)
Copyrequire 'razorpay' Razorpay.setup('key_id', 'key_secret') payment_response = { 'razorpay_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 = { 'razorpay_order_id': '12122', 'razorpay_payment_id': '332', 'razorpay_signature': '23233' } client.utility.verify_payment_signature(params_dict)
Copy Dictionary<string, string> attributes = new Dictionary<string, string>(); attributes.Add("razorpay_payment_id", paymentId); attributes.Add("razorpay_order_id", Request.Form["razorpay_order_id"]); attributes.Add("razorpay_signature", Request.Form["razorpay_signature"]); Utils.verifyPaymentSignature(attributes);

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.

Payment Capture Settings🔗

After a payment is authorized, you need to capture the payment made by the customer for the amount to be settled to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time period.

  • Auto-capture payments (recommended)
    Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard. Watch Out
    Payment capture settings work only you have integrated with Orders API in 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:

Know more about Capture Settings for payments.

Test Integration🔗

After the integration is complete, you need to test the integration to ensure that it is working as expected. You can make a test transaction using the test cards, verify the payment status from the Razorpay Dashboard or through 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 actual payments from your customers.

Test Payments🔗

You can make test payments using any of the payment methods configured at 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

5267 3181 8797 5449

Visa

Domestic

4111 1111 1111 1111

Mastercard

International

5555 5555 5555 4444
5105 1051 0510 5100

Visa

International

4012 8888 8888 1881
5104 0600 0000 0008

Handy Tips
UPI payments should be tested in Live Mode.

Verify Payment Status🔗

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

From Dashboard🔗

  1. Log into the Dashboard and navigate to Transactions → Payments.
  2. Check 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. Know how to set up Webhooks.

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 and confident that the integration is working as expected, switch to the live mode and start accepting payments from customers. However, make sure that you 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 Settings → API Keys → Generate Key to generate 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.
×