> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 in to 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.

<Info>
  **Feature Request**

  This is an on-demand feature. Please raise a request with our [Support team](https://razorpay.com/support/#request) to get this feature activated on your Razorpay account.

  to get this feature activated on your account.
</Info>

## User Flow

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

<Steps>
  <Step title="Step 1">
    Customers log in to the PhonePe app and click **PhonePe Switch**.
  </Step>

  <Step title="Step 2">
    In the PhonePe Switch, customers select your app, place orders and click **Proceed to Pay**.
  </Step>

  <Step title="Step 3">
    Customers are redirected to the PhonePe payment page.
  </Step>

  <Step title="Step 4">
    After the successful payment on the PhonePe payment page, customers are redirected to your website.
  </Step>
</Steps>

## Prerequisites

Before integrating with the Checkout, run through this checklist:

* Check if your webapp is integrated with PhonePe Switch.
* Understand the [payment flow](/payments/payment-gateway/how-it-works).
* Sign up for a Razorpay Account.
* Generate the API keys from the [Dashboard](/payments/dashboard/account-settings#api-keys). Use the test API Keys to test out the integration.

Watch the video to see how to generate API key in Test Mode.

<Warning>
  **PCI DSS Certification**

  A customer's payment information should never reach your servers, unless you are PCI DSS certified.
</Warning>

## Integration Steps

Steps to integrate Custom Checkout in your site:

1. [Create an Order from your Server](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-1-create-an-order-from-your-server).
2. [Invoke Checkout and Pass Order Id and Other Options to it](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-2-invoke-checkout-and-pass-order-id)
3. [Include the JavaScript code in your Webpage](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-21-include-the-javascript-code-in-your).
4. [Instantiate Razorpay Custom Checkout](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-22-instantiate-razorpay-custom-checkout).
5. [Submit Payment Details](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-23-submit-payment-details).
6. [Store Fields in Your Server](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-3-store-fields-in-your-server).
7. [Verify the Signature](/payments/payment-gateway/web-integration/custom/phonepe-switch#step-4-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

````curl: Request theme={null}
curl -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\"}]}}"
}'
```json: Response
{
    "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*

`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 \`\` section of your page:

```html: Index HTML theme={null}
```

<Info>
  **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

  ```js: Invoke a Single Instance theme={null}
  var razorpay = new Razorpay({
    key: '',
      // logo, displayed in the payment processing popup
    image: 'https://i.imgur.com/n5tjHFD.jpg',
  });
  ```

  #### Multiple Instances on Same Page

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

  ```js: Invoke Multiple Instances theme={null}
  Razorpay.configure({
    key: '',
      // logo, displayed in the payment processing popup
    image: 'https://i.imgur.com/n5tjHFD.jpg',
  })
  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:

  ````js: createPayment with handler Function theme={null}
    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
    });
  ```js: createPayment with callback URL
    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);
    });
  ````

  **ERROR**

  **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 theme={null}
  $('button').click( function (){ razorpay.createPayment(...) })
  ```
</Info>

<Info>
  **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.
</Info>

### Step 3: Store Fields in Your Server

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.

```json: Success Callback theme={null}
{
  "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 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](/payments/dashboard/account-settings/api-keys#generate-api-keys).

2. Use the SHA256 algorithm, the `razorpay_payment_id` and the `order_id` to construct a HMAC hex digest as shown below:

   ```html: HMAC Hex Digest theme={null}
   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: Java theme={null}
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);

```php: PHP
$api = new Api($key_id, $secret);

$api->utility->verifyPaymentSignature(array('razorpay_order_id' => $razorpayOrderId, 'razorpay_payment_id' => $razorpayPaymentId, 'razorpay_signature' => $razorpaySignature));

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

payment_response = {
       razorpay_order_id: 'order_IEIaMR65cu6nz3',
       razorpay_payment_id: 'pay_IH4NVgf4Dreq1l',
       razorpay_signature: '0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f'
     }
Razorpay::Utility.verify_payment_signature(payment_response)

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.utility.verify_payment_signature({
  'razorpay_order_id': razorpay_order_id,
  'razorpay_payment_id': razorpay_payment_id,
  'razorpay_signature': razorpay_signature
  })

```c: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary options = new Dictionary();
options.Add("razorpay_order_id", "order_IEIaMR65");
options.Add("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");
options.Add("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50");

Utils.verifyPaymentSignature(options);

```nodejs: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

var { validatePaymentVerification, validateWebhookSignature } = require('./dist/utils/razorpay-utils');
validatePaymentVerification({"order_id": razorpayOrderId, "payment_id": razorpayPaymentId }, signature, secret);

```Go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

params := map[string]interface{}{
 "razorpay_order_id": "order_IEIaMR65cu6nz3",
 "razorpay_payment_id": "pay_IH4NVgf4Dreq1l",
}

signature := "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f";
secret := "EnLs21M47BllR3X8PSFtjtbd";
utils.VerifyPaymentSignature(params, signature, secret)
````

### Post Signature Verification

After you have completed the integration, you can [set up webhooks](/webhooks/setup-edit-payments), make test payments, replace the test key with the live key and integrate with other [APIs](/api).

## Payment Capture Settings

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.

<Warning>
  **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](/api/payments#fetch-a-payment) or webhooks.

    Authorized payments can be automatically captured. You can auto-capture all payments [using global settings](/payments/payments/capture-settings#auto-capture-all-payments) on the Razorpay Dashboard. Know more about [capture settings for payments](/payments/payments/capture-settings).
</Warning>

<Warning>
  **Watch Out!**

  Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the [Orders API](/api/orders/create).

  Each authorized payment can also be captured individually. You can manually capture payments using [Payment Capture API](/api/payments#capture-a-payment) or [Dashboard](/payments/payments/dashboard#manually-capture-payments). Know more about [capture settings for payments](/payments/payments/capture-settings).

  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.
</Warning>

<Warning>
  **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](/payments/dashboard/account-settings/api-keys#generate-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 Card](/payments/payment-methods/cards) | `debit` | ✓

  ## [Credit Card](/payments/payment-methods/cards) | `credit` | ✓

  ## [Netbanking](/payments/payment-methods/netbanking) | `netbanking`| ✓

  ## [UPI](/payments/payment-methods/upi) | `upi` | ✓

  ## EMI - [Credit Card EMI](/payments/payment-methods/emi/credit-card-emi), [Debit Card EMI](/payments/payment-methods/emi/debit-card-emi) and [No Cost EMI](/payments/payment-methods/emi/no-cost-emi) | `emi` | ✓

  ## [Wallet](/payments/payment-methods/wallets) | `wallet` | ✓

  ## [Cardless EMI](/payments/payment-methods/emi/cardless-emi) | `cardless_emi` | Requires [Approval](https://razorpay.com/support).

  ## [Bank Transfer](/payments/payment-methods/bank-transfer) | `bank_transfer` | Requires [Approval](https://razorpay.com/support) and Integration.

  ## [Emandate](/payments/recurring-payments/emandate/integrate) | `emandate` | Requires [Approval](https://razorpay.com/support) and Integration.

  [Pay Later](/payments/payment-methods/pay-later)| `paylater` | Requires [Approval](https://razorpay.com/support).

  You can make test payments using one of the payment methods configured at the Checkout.
</Warning>

### Netbanking

You can select any of the listed banks. After choosing a bank, Razorpay will redirect 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 bank login portals.

Check the list of [supported banks](/payments/payment-methods/netbanking#supported-banks).

### UPI

You can enter one of the following UPI IDs:

* `success@razorpay`: To make the payment successful.
* `failure@razorpay`: To fail the payment.

Check the list of [supported UPI flows](/payments/payment-methods/upi).

<Info>
  **Handy Tips**

  You can use **Test Mode** to test UPI payments, and **Live Mode** for UPI Intent and QR payments.
</Info>

### Cards

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

### Domestic Cards

Use the following test cards for Indian payments:

## Network | Card Number | CVV & Expiry Date

## Visa  | 4100 2800 0000 1007 | Use a random CVV and any future date ^^^^^

## Mastercard | 5500 6700 0000 1002 |

## RuPay | 6527 6589 0000 1005 |

## Diners | 3608 280009 1007 |

Amex | 3402 560004 01007 |

#### Error Scenarios

Use these test cards to simulate payment errors. See the [complete list](/payments/payments/test-card-details#error-scenario-test-cards) of error test cards with detailed scenarios.
Check the following lists:

* [Supported Card Networks](/payments/payment-methods/cards).
* [Cards Error Codes](/errors/payments/cards).

### International Cards

Use the following test cards to test international payments. Use any valid expiration date in the future in the MM/YY format and any random CVV to create a successful payment.

## Card Network | Card Number | CVV & Expiry Date

Mastercard | 5555 5555 5555 4444
5105 1051 0510 5100
5104 0600 0000 0008 | Use a random CVV and any future date ^^
-------------------------------------------------------------

Visa | 4012 8888 8888 1881 |

Check the list of [supported card networks](/payments/payment-methods/cards).

### Wallet

You can select any of the listed wallets. After choosing a wallet, Razorpay will redirect 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.

Check the list of [supported wallets](/payments/payment-methods/wallets#supported-wallets).

### Related Information

* [Webhooks](/webhooks) (Recommended)
* [Error Codes](/errors) (Recommended)
* [How Payment Gateway Works](/payments/payment-gateway/how-it-works)
* [Payment States](/payments/payments)
* [Settlements](/payments/settlements)
* [Refunds](/payments/refunds)
