UPI API INTEGRATION DOCUMENT
Purpose :- This guide is a step by step process for merchants of all business types to integrate their e-commerce applications and websites with payment gateway India Online Pay for UPI Payment Services.
Transaction Request Parameter
URL:- https://indiaonlinepay.com/api/iopregisterupiintent
Accept And opStatus - Key=”accept” value=” application/json” - Key=” opStatus” value=”Paster either 1 (Live Transaction) or 0 (Sandbox Transaction) ” - E.g. Key=” opStatus” value=”1”
| Sr. No | Parameter Name | Description | Mandatory / Optional / Condition |
|---|---|---|---|
| 1 | mId | Encrypted Value of IndiaOnlinePay Merchant Identifier ( This is provided in Button Generator within IOP Merchant Portal Interface under Integration ) | Mandatory |
| 2 | amount | Transaction Amount in INT | Mandatory |
| 3 | invno | Merchant Invoice Number defined by the Merchant | Mandatory |
Process Workflow:
Transaction Request Parameter
URL:- https://indiaonlinepay.com/api/iopupiresponsewebhook
Step 2 : Request Header should contain mandatory Parameter :
Accept And opStatus - Key=”accept” value=”application/json” - Key=”opStatus” value=”Paster either 1 (Live Transaction) or 0 (Sandbox Transaction) ” - E.g. Key=”opStatus” value=”1”
| Sr. No | Parameter Name | Description | Mandatory / Optional / Condition |
|---|---|---|---|
| 1 | orderId | Order Id received in Intent Registration API Response. | Mandatory |
| 2 | opStatus | ey=”opStatus” value=”Paster either 1 (Live Transaction) or 0 (Sandbox Transaction) ” - E.g. Key=”opStatus” value=”1” | Mandatory |
Process Workflow:
Step 1 :- The first step is to generate the UPI Intent.
Step 2 : Request Header should contain mandatory Parameter :
Accept And opStatus - Key=”accept” value=”application/json” - Key=”opStatus” value=”Paster either 1 (Live Transaction) or 0 (Sandbox Transaction) ” - E.g. Key=”opStatus” value=”1”
Step 3 :- You will get the following response:
Step 4 :- This response is received in a Json format. The sample for this is listed as below:
status : SUCCESS / FAILURE / REJECT,
"sellerIdentifier" : "IOP00000123",
"payeeName" : "ACME%20ASSOCIATES%20PRIVATE%20LIMITED",
"vpa" : ypay.gllsiop000000123@yesb
"merchantIdentifier" : FFFFABTRUQ4WXX4YR
"amount" : 1.00
"currency" : INR
"expiryDate" : 2023-06-29%2000:07:35
"responseCode" : 00
"responseMessage" : UPI%20intent%20has%20been%20registered%20successfully
"intent" : "upi://pay?pa=ypay.gllsiop000000123@yesb&pn=ACME%20ASSOCIATES%20PRIVATE%20LIMITED&mc=5327&tr=TRN2306290004678&tn=FFFFABTRUQ4WXX4YR&am=1.00&cu=INR&url=https://acme.com
"transactionDate" : "2023-06-29%2012:04:41", }
Purpose :- This guide is a step by step process for merchants of all business types to integrate their e-commerce applications and websites with payment gateway India Online Pay for UPI Payment Services.
UPI Intent Transaction Status Request Parameter
URL:- https://indiaonlinepay.com/api/iopupiresponsewebhookt
Accept And opStatus - Key=”accept” value=” application/json” - Key=” opStatus” value=”Paster either 1 (Live Transaction) or 0 (Sandbox Transaction) ” - E.g. Key=” opStatus” value=”1”
| Sr. No | Parameter Name | Description | Mandatory / Optional / Condition |
|---|---|---|---|
| 1 | orderId | This is the ORDER ID you received in the Intent Response. | Mandatory |
| 2 | opStatus | Its Value is either 1 or 0 . 1 specifies LIVE Transaction and 0 specifies SANDBOX Transaction. | Mandatory |
Process Workflow:
Step 1 :- The first step is to generate the UPI Intent Status Request using this Web Hook URL.
Step 2 :- In order to generate the UPI Intent Status, you have to call API with headers and following URL:
Step 3 :- You will get the following response:
Step 4 :- This response is received in a Json format. The sample for this is listed as below:
status : SUCCESS / FAILURE / REJECT / ERROR,
"amount" : 1.00
"transactionStatus" : SUCCESS / FAILURE / REJECT / ERROR
"invoiceNumber" : INV-001
"merchantIdentifier" : FFFFABTRUQ4WXX4YR
"responseCode" : 00
"responseMessage" : UPI%20intent%20has%20been%20registered%20successfully
}