Unified Payments Interface (UPI) is the preferred digital payment method among Indian consumers, with over 385 million users and more than 172 billion transactions processed annually, highlighting its widespread adoption and popularity. Learn more about UPI.

Payment method properties

Make a UPI payment

UPI is available through our standardized REDIRECT and SCAN_CODE flows. Enabling you to offer a seamless desktop or in-store QR code to mobile handoff experience.

To create a UPI payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Request:

{
  "paymentMethod": "UPI",
  "amount": {
    "value": 100000,
    "currency": "INR"
  },
  "consumer": {
    "country": "IN"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
  "id": "charge_CC2UVDUgFjdU67dcLkc0I",
  "paymentMethod": "UPI",
  "paymentMedium": "ECOMMERCE",
  "scheduleType": "UNSCHEDULED",
  "instrumentId": "instr_CWXQyo8lM0YwOvFAT9n33",
  "currency": "INR",
  "country": "IN",
  "status": "AUTHENTICATION_PENDING",
  "consumer": {
    "country": "IN"
  },
  "authenticationMethods": [
    {
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      },
      "type": "REDIRECT"
    },
    {
      "details": {},
      "type": "MULTI_FACTOR"
    },
    {
      "details": {
        "mobileIntentUri": "upiGlobal://paymentrequest?token=AAAAAAAAAAAAABYJmXQEEojHxoSjfRCF"
      },
      "type": "APP_INTENT"
    },
    {
      "details": {
        "codeType": "QR",
        "codeImage": "https://qr.ppro.com/payment/charge_CC2UVDUgFjdU67dcLkc0I/qr.png",
        "codePayload": "charge_CC2UVDUgFjdU67dcLkc0I",
        "codeDocument": "cdn.ppro.com/document.html?charge=charge_CC2UVDUgFjdU67dcLkc0I",
        "scanBy": "2025-06-22T15:14:32.222Z"
      },
      "type": "SCAN_CODE"
    }
  ],
  "authorizations": [
    {
      "id": "authz_pdruNt2IXEdRc5cCLVqiR",
      "amount": 100000,
      "status": "AUTHENTICATION_PENDING",
      "createdAt": "2025-06-21T15:14:32.265Z",
      "updatedAt": "2025-06-21T15:14:32.265Z"
    }
  ],
  "captures": [],
  "refunds": [],
  "voids": [],
  "createdAt": "2025-06-21T15:14:32.181Z",
  "updatedAt": "2025-06-21T15:14:32.265Z",
  "_links": {
    "authorizations": {
      "href": "/v1/payment-charges/charge_CC2UVDUgFjdU67dcLkc0I/authorizations"
    },
    "captures": {
      "href": "/v1/payment-charges/charge_CC2UVDUgFjdU67dcLkc0I/captures"
    },
    "refunds": {
      "href": "/v1/payment-charges/charge_CC2UVDUgFjdU67dcLkc0I/refunds"
    },
    "voids": {
      "href": "/v1/payment-charges/charge_CC2UVDUgFjdU67dcLkc0I/voids"
    }
  }
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will be presented with the payment slip (voucher) and instructions to complete the payment.

SCAN_CODE

1. Render the code using one of the techniques available.
2. The consumer will scan the code to complete the payment.

APP_INTENT

1. Use the intent system on Android or a similar mechanism on iOS to trigger the URI.
2. The consumer will be taken to the native app to complete the payment.

Handling the payment result

REDIRECT

1. After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
2. Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
3. Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

SCAN_CODE

1. You'll be notified of the payment outcome via Webhook.
2. You can check the payment status at any time by making a GET /v1/payment-charges/{paymentChargeId}.
3. Use the Status that you received to display the payment outcome to the consumer.

APP_INTENT

1. Once the consumer has confirmed the payment, they are returned to your app using the mobileIntentUri provided in the initial payment charge creation request.
2. After the consumer is redirected back to your app, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for UPI, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_CWXQyo8lM0YwOvFAT9n33",
    "type": "PASSTHROUGH_WALLET"
}