REST API Version 2.0

Developer Documentation

Integrate UPI Gateway UPI Gateway into any application. Accept 0% fee payments with instant QR codes and real-time webhook callbacks.

1. Get API Token

Login to merchant dashboard and copy your secret user_token from API Details.

2. Create Order

Send a POST request to /api/create-order.php to generate an instant payment URL.

3. Instant Webhook

Receive real-time payment confirmation payloads on your backend callback endpoint.

Create Order API

Initialize a UPI payment session and receive a customer checkout URL.

POST https://www.free.upigateway.dev/api/create-order.php

Request Body Parameters (POST / Form-Data)

Parameter Type Required Description
user_token String Required Your unique merchant API token from API Details.
amount Decimal / String Required Order amount in INR (e.g. "500.00").
order_id String Required Unique alphanumeric order identifier (e.g. "ORD_100234").
customer_mobile String Required Customer 10-digit mobile number.
redirect_url URL Required Customer redirect destination upon payment completion.
remark1 String Optional Item description or transaction note.

Sample Success Response (200 / 201)

{
  "status": true,
  "message": "Order Created Successfully",
  "result": {
    "orderId": "ORD_100234",
    "payment_url": "https://www.free.upigateway.dev/payment/instant-pay/329f10a842b109c847"
  }
}

Check Order Status API

Query real-time status and bank UTR reference for an existing order.

POST https://www.free.upigateway.dev/api/check-order-status.php

Request Body Parameters

Parameter Type Required Description
user_token String Required Your merchant API secret key.
order_id String Required Unique order identifier to query.

Sample Response

{
  "status": "COMPLETED",
  "message": "Transaction Successfully",
  "result": {
    "orderId": "ORD_100234",
    "status": "SUCCESS", // SUCCESS, PENDING, or FAILURE
    "amount": "500.00",
    "utr": "423984710293",
    "date": "2026-09-27 15:19:32"
  }
}

Realtime Webhook Callbacks

Configure your Webhook URL under API Details. When a payment completes, our gateway immediately dispatches an HTTP POST payload.

Sample Webhook Callback Payload

{
  "status": "SUCCESS",
  "order_id": "ORD_100234",
  "amount": "500.00",
  "utr": "423984710293",
  "customer_mobile": "9876543210",
  "create_date": "2026-09-27 15:19:32"
}

Ready to Integrate Payments?

Get your free merchant API credentials and start accepting payments in minutes.