1. Overview & Authentication

PhonePey provides a clean REST API. You can create orders and verify payments in real time. Authentication is fast. Pass your user_token with each request.

2. Create Order API

POST /api/create-order

Create a dynamic UPI checkout session. Buyers can scan a QR code or tap a 1-click intent button for PhonePe, Google Pay, or Paytm.

Two Checkout Options: Razorpay-Style Popup vs Hosted Redirect

1. Popup Modal (Razorpay Style - Recommended): Keep buyers on your website without leaving your page. Pass the returned token to new PhonePey({ token }).open() (see Chapter 5).
2. Hosted Redirect Page: Send buyers to the hosted PhonePey page by redirecting them to result.payment_url.

Request Parameters:

Parameter	Type	Requirement	Description
`user_token`	string	Required	Your unique merchant integration token obtained from Developer Settings.
`amount`	string / float	Required	Transaction amount (e.g. `"149"` or `149.00`). Min ₹1.00.
`order_id`	string	Required	Your custom unique order identifier (e.g. `"ORD_174000123"`).
`customer_mobile`	string	Required	Customer's active 10-digit mobile number.
`redirect_url`	string	Required	Destination URL where customer is redirected upon successful payment.
`remark1`	string	Optional	Internal customer name, product title, or correlation note.
`remark2`	string	Optional	Additional server-side tracking reference.

curl -X POST https://www.phonepey.lushai.dev/api/create-order \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "YOUR_USER_TOKEN",
    "amount": "149.00",
    "order_id": "ORD_174000123",
    "customer_mobile": "9876543210",
    "redirect_url": "https://yourwebsite.com/payment-success",
    "remark1": "Pro Plan Subscription"
  }'

<?php
$url = "https://www.phonepey.lushai.dev/api/create-order";
$payload = [
    "user_token"      => "YOUR_USER_TOKEN",
    "amount"          => "149.00",
    "order_id"        => "ORD_" . time(),
    "customer_mobile" => "9876543210",
    "redirect_url"    => "https://yourwebsite.com/payment-success",
    "remark1"         => "Pro Plan Subscription"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
if (!empty($result['status']) && !empty($result['result']['payment_url'])) {
    // Redirect customer to PhonePe payment URL
    header("Location: " . $result['result']['payment_url']);
    exit;
} else {
    echo "Order error: " . ($result['message'] ?? 'Failed to create order');
}
?>

const response = await fetch('https://www.phonepey.lushai.dev/api/create-order', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    user_token: 'YOUR_USER_TOKEN',
    amount: '149.00',
    order_id: 'ORD_' + Date.now(),
    customer_mobile: '9876543210',
    redirect_url: 'https://yourwebsite.com/payment-success',
    remark1: 'Pro Plan Subscription'
  })
});

const data = await response.json();
if (data.status) {
  console.log('Payment URL:', data.result.payment_url);
  console.log('UPI Intent URI:', data.result.upi_intent);
  // window.location.href = data.result.payment_url;
}

import requests, time

url = "https://www.phonepey.lushai.dev/api/create-order"
payload = {
    "user_token": "YOUR_USER_TOKEN",
    "amount": "149.00",
    "order_id": f"ORD_{int(time.time())}",
    "customer_mobile": "9876543210",
    "redirect_url": "https://yourwebsite.com/payment-success",
    "remark1": "Pro Plan Subscription"
}

res = requests.post(url, json=payload)
data = res.json()
print("Payment URL:", data.get("result", {}).get("payment_url"))

import 'dart:convert';
import 'package:http/http.dart' as http;
import 'package:url_launcher/url_launcher.dart';

Future<void> initiatePhonePePayment() async {
  final response = await http.post(
    Uri.parse('https://www.phonepey.lushai.dev/api/create-order'),
    headers: {'Content-Type': 'application/json'},
    body: jsonEncode({
      'user_token': 'YOUR_USER_TOKEN',
      'amount': '149.00',
      'order_id': 'ORD_${DateTime.now().millisecondsSinceEpoch}',
      'customer_mobile': '9876543210',
      'remark1': 'Mobile App In-App Purchase',
    }),
  );

  final data = jsonDecode(response.body);
  if (data['status'] == true) {
    final upiIntent = data['result']['upi_intent'];
    // Launch PhonePe or any installed UPI App directly on Android/iOS
    if (await canLaunchUrl(Uri.parse(upiIntent))) {
      await launchUrl(Uri.parse(upiIntent), mode: LaunchMode.externalApplication);
    } else {
      // Fallback to web checkout
      await launchUrl(Uri.parse(data['result']['payment_url']));
    }
  }
}

import { Linking } from 'react-native';

const handlePhonePeCheckout = async () => {
  try {
    const res = await fetch('https://www.phonepey.lushai.dev/api/create-order', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({
        user_token: 'YOUR_USER_TOKEN',
        amount: '149.00',
        order_id: 'ORD_' + Date.now(),
        customer_mobile: '9876543210',
      }),
    });

    const data = await res.json();
    if (data.status) {
      const upiUri = data.result.upi_intent;
      const supported = await Linking.canOpenURL(upiUri);
      if (supported) {
        await Linking.openURL(upiUri);
      } else {
        await Linking.openURL(data.result.payment_url);
      }
    }
  } catch (err) {
    console.error('Payment Error:', err);
  }
};

JSON Response (200 OK):

{
  "status": true,
  "message": "Order created successfully",
  "result": {
    "order_id": "ORD_174000123",
    "payment_url": "https://www.phonepey.lushai.dev/pay?token=8c4e51...",
    "amount": "149.00",
    "token": "8c4e5192c73bb...",
    "upi_intent": "upi://pay?pa=store@ybl&pn=Store&am=149.00&cu=INR&tn=ORD_174000123",
    "qr_data": "upi://pay?pa=store@ybl&pn=Store&am=149.00&cu=INR&tn=ORD_174000123",
    "created_at": "2026-08-22 17:20:00"
  }
}

3. Check Order Status API

POST /api/check-status

Check the real-time status of an order using your order_id. When paid, the engine returns the verified 12-digit UTR number.

Request Parameters:

Parameter	Type	Requirement	Description
`user_token`	string	Required	Your merchant integration token.
`order_id`	string	Required	The specific unique order ID string to verify status for.

curl -X POST https://www.phonepey.lushai.dev/api/check-status \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "YOUR_USER_TOKEN",
    "order_id": "ORD_174000123"
  }'

<?php
$url = "https://www.phonepey.lushai.dev/api/check-status";
$payload = [
    "user_token" => "YOUR_USER_TOKEN",
    "order_id"   => "ORD_174000123"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
if (!empty($result['status']) && $result['result']['status'] === 'SUCCESS') {
    echo "Payment Verified! UTR: " . $result['result']['utr'];
}
?>

const response = await fetch('https://www.phonepey.lushai.dev/api/check-status', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    user_token: 'YOUR_USER_TOKEN',
    order_id: 'ORD_174000123'
  })
});

const data = await response.json();
if (data.status && data.result.status === 'SUCCESS') {
  console.log('Payment Successful! UTR:', data.result.utr);
}

import requests

res = requests.post("https://www.phonepey.lushai.dev/api/check-status", json={
    "user_token": "YOUR_USER_TOKEN",
    "order_id": "ORD_174000123"
})

data = res.json()
if data.get("status") and data.get("result", {}).get("status") == "SUCCESS":
    print("Verified UTR:", data["result"]["utr"])

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<bool> checkOrderStatus(String orderId) async {
  final res = await http.post(
    Uri.parse('https://www.phonepey.lushai.dev/api/check-status'),
    headers: {'Content-Type': 'application/json'},
    body: jsonEncode({
      'user_token': 'YOUR_USER_TOKEN',
      'order_id': orderId,
    }),
  );

  final data = jsonDecode(res.body);
  if (data['status'] == true && data['result']['status'] == 'SUCCESS') {
    print('Verified UTR: ${data['result']['utr']}');
    return true;
  }
  return false;
}

const pollPaymentStatus = async (orderId) => {
  const res = await fetch('https://www.phonepey.lushai.dev/api/check-status', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      user_token: 'YOUR_USER_TOKEN',
      order_id: orderId,
    }),
  });

  const data = await res.json();
  if (data.status && data.result.status === 'SUCCESS') {
    console.log('Payment Successful! UTR:', data.result.utr);
    return true;
  }
  return false;
};

Verified JSON Response:

{
  "status": true,
  "message": "Order status retrieved",
  "result": {
    "order_id": "ORD_174000123",
    "status": "SUCCESS",
    "amount": "149.00",
    "utr": "412398765432",
    "verified": true,
    "transaction_date": "2026-08-22 17:21:00",
    "remark1": "Pro Plan Subscription"
  }
}

4. Webhooks & Instant Payment Notifications

When a customer payment succeeds, PhonePey sends an instant HTTP POST event to your Webhook URL. You can set your Webhook URL in Developer Settings:

                        WEBHOOK PAYLOAD (POST)
                    
{
  "event": "order.paid",
  "timestamp": "2026-08-22T17:21:00+05:30",
  "order_id": "ORD_174000123",
  "amount": "149.00",
  "utr": "412398765432",
  "status": "SUCCESS",
  "remark1": "Pro Plan Subscription"
}

                        PHP WEBHOOK LISTENER EXAMPLE
                    
<?php
$payload = file_get_contents('php://input');
$event = json_decode($payload, true);

if ($event && ($event['status'] ?? '') === 'SUCCESS') {
    $orderId = $event['order_id'];
    $utr = $event['utr'];
    $amount = $event['amount'];

    // Update your database order as PAID
    // fulfill_order($orderId, $utr);

    http_response_code(200);
    echo json_encode(['status' => 'acknowledged']);
} else {
    http_response_code(400);
}
?>

5. JavaScript Embed SDK (Razorpay-Style Popup Modal)

Recommended for All Websites

Integrate a seamless, in-context popup checkout modal just like Razorpay or Cashfree. Your customers complete payment directly on your page without being redirected away to an external site.

Approach 1: Direct 1-Click Drop-in (Low Code)

HTML / JAVASCRIPT (DROP-IN POPUP)

<!-- 1. Include PhonePey Drop-in SDK -->
<script src="https://www.phonepey.lushai.dev/checkout.js"></script>

<!-- 2. Trigger Payment Button -->
<button id="pay-btn" class="btn btn-primary">Pay ₹149 with UPI</button>

<script>
document.getElementById('pay-btn').addEventListener('click', function () {
    var options = {
        key: "YOUR_API_TOKEN", // From PhonePey Dashboard > API Integration
        amount: 149.00,
        order_id: "ORD_" + Date.now(),
        name: "My Online Store",
        prefill: {
            name: "Lalmuana",
            contact: "9876543210",
            email: "customer@example.com"
        },
        handler: function (response) {
            // Instant verification callback upon customer payment
            alert("Payment Verified! UTR: " + response.utr);
            window.location.href = "/payment-success?order_id=" + response.order_id + "&utr=" + response.utr;
        },
        modal: {
            ondismiss: function () {
                console.log("Customer closed the checkout modal.");
            }
        }
    };

    var rzp = new PhonePey(options);
    rzp.open();
});
</script>

Approach 2: Server-Side Order + Client-Side Popup Modal (Standard Razorpay Architecture)

Create the order securely on your server using POST /api/create-order, return the generated token to your frontend, and open the popup modal:

FRONTEND JAVASCRIPT WITH BACKEND TOKEN

<!-- 1. Include PhonePey SDK -->
<script src="https://www.phonepey.lushai.dev/checkout.js"></script>

<script>
async function startCheckout() {
    // Step 1: Request token from your backend server
    const res = await fetch('/my-backend/create-order.php', { method: 'POST' });
    const data = await res.json(); // returns { token: "8c4e51...", order_id: "ORD_..." }

    // Step 2: Launch in-context Razorpay-style popup modal!
    var rzp = new PhonePey({
        token: data.token, // Token returned from PhonePey /api/create-order
        handler: function (response) {
            // Step 3: Verified UTR callback!
            window.location.href = "/order-confirmed?order_id=" + response.order_id + "&utr=" + response.utr;
        },
        modal: {
            ondismiss: function () {
                console.log("Customer closed checkout popup.");
            }
        }
    });

    rzp.open();
}
</script>

Official Plugin • Razorpay-Style Popup Enabled • WooCommerce 4.0 - 9.2+

6. Official WooCommerce UPI Gateway Plugin

Connect your WooCommerce e-commerce store with PhonePey. Accept 0% fee UPI payments straight into your bank account. Features **In-Context Popup Modal (Razorpay Style)** by default, so customers never leave your website!

Download Plugin (.ZIP)

STEP 1

Instant Installation

Download the ZIP file. In your WordPress Admin, go to Plugins → Add New → Upload Plugin, choose phonepey-woocommerce.zip, click Install Now and Activate.

STEP 2

One-Key Configuration

Navigate to WooCommerce → Settings → Payments → PhonePey UPI. Enable the gateway and paste your API Key (user_token) from your PhonePey Dashboard.

STEP 3

Automated Instant Fulfillment

Copy your Webhook endpoint: https://yourdomain.com/?wc-api=phonepey_webhook and paste it into your PhonePey API Integration settings. All paid orders automatically update to Processing with UTR reference recorded!

7. Auto Payment Capture & Merchant Setup Guides

PhonePey delivers instant 0% commission direct settlement. To enable automated real-time transaction verification, complete these 2 quick setup steps:

STEP 1

Add Email in PhonePe Business App

Link your notification Gmail address inside your PhonePe Business profile

STEP 2

Google Settings

Generate Google App Password

Create a 16-character secure App Password for IMAP auto-capture

8. UPI Intent & Mobile Deep Link Specs

Construct custom mobile deep links to trigger installed UPI applications directly on customer mobile devices:

Target App	Intent Scheme Format
PhonePe	`phonepe://pay?pa={VPA}&pn={NAME}&am={AMOUNT}&cu=INR&tn={NOTE}`
Google Pay	`gpay://upi/pay?pa={VPA}&pn={NAME}&am={AMOUNT}&cu=INR&tn={NOTE}`
Paytm	`paytmmp://pay?pa={VPA}&pn={NAME}&am={AMOUNT}&cu=INR&tn={NOTE}`
Universal UPI	`upi://pay?pa={VPA}&pn={NAME}&am={AMOUNT}&cu=INR&tn={NOTE}`

9. Interactive Live API Tester & Demo

Open Full Checkout Demo

Execute live test requests to /api/create-order directly in your browser, or visit our dedicated Live Checkout Simulator to test real-time 10–40s auto-capture:

Compatible Apps: UPI

order_id

Amount (₹)

customer_mobile

user_token

                        API RESPONSE
                        AWAITING REQUEST
                    
Click "Execute Create Order Request" above to test live endpoint...

10. HTTP Status Codes & Error Handling

PhonePey returns standard HTTP response codes alongside JSON error objects:

Code	Meaning	Typical Cause
200 OK	Success	Order created or status retrieved successfully.
401 Unauthorized	Invalid Token	Missing, invalid, or expired `user_token`.
422 Unprocessable	Validation Error	Missing `order_id`, invalid `customer_mobile`, or amount < ₹1.
404 Not Found	Not Found	Order identifier does not exist in your account.

Developer API & Integration Guide

1. Overview & Authentication

2. Create Order API

Request Parameters:

JSON Response (200 OK):

3. Check Order Status API

Request Parameters:

Verified JSON Response:

4. Webhooks & Instant Payment Notifications

5. JavaScript Embed SDK (Razorpay-Style Popup Modal)

Approach 1: Direct 1-Click Drop-in (Low Code)

Approach 2: Server-Side Order + Client-Side Popup Modal (Standard Razorpay Architecture)

6. Official WooCommerce UPI Gateway Plugin

7. Auto Payment Capture & Merchant Setup Guides

8. UPI Intent & Mobile Deep Link Specs

9. Interactive Live API Tester & Demo

10. HTTP Status Codes & Error Handling