Developer API Documentation

1. Overview & Architecture

WebPress Pay is a direct-to-bank peer-to-peer UPI payment facilitation engine. It allows merchants to generate dynamic UPI QR codes and 1-tap mobile deep links (PhonePe, Google Pay, Paytm, BHIM, CRED) and reconciles payments in real time using 12-digit bank UTR numbers.

2. Authentication & API Keys

All API requests require authentication via your unique Merchant User Token (`user_token`). You can find or regenerate your secret token inside the Merchant Dashboard under API Credentials.

3. Base URLs & Content Types

Initiates a payment session and returns a secure hosted checkout URL.

Request Parameters:

Success Response (HTTP 201 Created):

{
  "status": true,
  "message": "Order Created Successfully",
  "result": {
    "orderId": "ORDER_1724749200",
    "payment_url": "https://webpresspay.com/payment3/pay_now.php?token=a8f9c2e0b1d3..."
  }
}

Error Response (HTTP 400 / 401 / 403):

{
  "status": false,
  "message": "Invalid or unauthorized Merchant User Token"
}

Query the real-time settlement status of any previously initiated order.

Request Parameters:

Success Response — Paid (HTTP 200 OK):

{
  "status": "COMPLETED",
  "message": "Transaction Successfully",
  "result": {
    "txnStatus": "COMPLETED",
    "resultInfo": "Transaction Success",
    "orderId": "ORDER_1724749200",
    "status": "SUCCESS",
    "amount": "100.00",
    "date": "2026-08-27 14:30:00",
    "utr": "423984719283"
  }
}

6. Connection Diagnostic / Ping

Test whether your server can reach the WebPress Pay platform and confirm that your API token is valid without creating real orders.

{
  "status": true,
  "message": "Connection Successful! Merchant API Token is verified and active.",
  "result": {
    "token_status": "VALID",
    "mode": "LIVE"
  }
}

7. Webhook & Instant Payment Notification (IPN)

When a payment is verified, our automated background worker sends an asynchronous HTTP POST request to your configured Webhook URL.

Webhook Payload (HTTP POST):

{
  "order_id": "ORDER_1724749200",
  "amount": "100.00",
  "status": "SUCCESS",
  "customer_mobile": "9707842047",
  "remark1": "Order Checkout",
  "remark2": ""
}

Sample Webhook Listener (PHP):

<?php
$payload = $_POST;

if (!empty($payload['status']) && $payload['status'] === 'SUCCESS') {
    $orderId = $payload['order_id'];
    $amount  = $payload['amount'];
    
    // Fulfill customer order in your database
    // updateOrderStatus($orderId, 'PROCESSING');
    
    // Always return HTTP 200 JSON
    header('Content-Type: application/json');
    echo json_encode(['status' => true, 'message' => 'Order fulfilled']);
    exit;
}
?>

8. PHP SDK Integration

Download the official PHP SDK v1.3.0 for clean object-oriented integration.

<?php
require_once __DIR__ . '/WebPressPay.php';

$client = new WebPressPay('YOUR_MERCHANT_TOKEN', 'https://webpresspay.com');

// 1. Diagnostic test
$ping = $client->testConnection();
if (!$ping['success']) {
    die("Connection failed: " . $ping['message']);
}

// 2. Create Order
$order = $client->createOrder([
    'amount'          => 250.00,
    'order_id'        => 'INV_' . time(),
    'customer_mobile' => '9707842047',
    'redirect_url'    => 'https://yourwebsite.com/payment-complete'
]);

if (!empty($order['status'])) {
    // Redirect customer
    header('Location: ' . $order['result']['payment_url']);
    exit;
}
?>

9. WordPress WooCommerce Plugin Setup

1. Download upi-payment-woocommerce.zip from the SDK Files Page.
2. In your WordPress Admin, go to Plugins → Add New → Upload Plugin and upload the ZIP.
3. Activate the plugin.
4. Go to WooCommerce → Settings → Payments → WebPress Pay UPI.
5. Enter your Base URL (https://webpresspay.com) and Merchant Token.
6. Click Test Connection to confirm instant communication.
7. Save changes. Your checkout is now accepting direct UPI payments!

10. cURL Command Example

curl -X POST "https://webpresspay.com/api/create-order" \
  -d "user_token=YOUR_MERCHANT_TOKEN" \
  -d "amount=100.00" \
  -d "order_id=ORDER_12345" \
  -d "customer_mobile=9707842047" \
  -d "redirect_url=https://yourwebsite.com/success"

11. Error Codes & Troubleshooting