Skip to main content
UPI App Priority Reordering allows merchants to configure the order in which UPI apps are displayed on the checkout page. By controlling the display order, merchants can prioritise apps that align with business preferences or customer behaviour and drive higher conversion rates.

Platform behaviour

The display and ordering of UPI apps vary by platform; SDK (Android or iOS) and mobile web each apply different rules.

SDK (Android or iOS)

For mobile SDK integrations, UPI apps are displayed based on:
  • Merchant-defined priority order
  • App installation status on the customer’s device
Only installed apps are displayed. Among them, display order follows the configured priority (e.g. Google Pay, then PhonePe, then Paytm).

MWeb

For MWeb integrations, UPI apps are displayed based on:
  • Top 3 display: The top 3 apps from the configured priority list are always displayed.
  • Universal access: These apps are shown irrespective of whether they are installed on the device.
  • iOS MWeb: The full list of PSPs is shown according to the configured priority order in Pay via any.

Configuration methods

Merchants can configure UPI app priority using one of the following methods. If multiple configurations exist, precedence rules apply.

Create Order API (highest precedence)

Set UPI app priority per order using the order_meta object in the Create Order API. The UPI app order can be customised per order.

Create Order API example

The following is an example of how to send UPI app priority in the Create Order API:
{
  "order_meta": {
    "upi_app_priority": ["gpay", "phonepe", "paytm", "navi", "cred", "supermoney", "amazonpay", "bhim", "mobikwik", "airtel", "popclub", "kiwi"]
  }
}

Merchant Dashboard

Configure the preferred top five UPI apps through the Cashfree Merchant Dashboard for a consistent experience across all transactions. See payment apps ordering for configuration steps.

Supported UPI apps

The following UPI apps can be included when configuring priority via the Dashboard or API:
  • Google Pay
  • PhonePe
  • Navi
  • BHIM
  • Paytm
  • CRED
  • Amazon Pay
  • MobiKwik
  • Airtel Payments Bank
  • Popclub
  • Kiwi
  • Supermoney

Configuration precedence

If multiple configurations are present, the system applies them in the following order of priority:
1

Create Order API configuration

Highest precedence; overrides all other settings when present in the API call. See Create Order API.
2

Merchant Dashboard configuration

Used when no API-level configuration is sent for the order.
3

Cashfree default priority

Used when no custom configuration is set by the merchant.