Payment API
Tips
- All requests are
Post
requests, and the data format isjson
Brief Description
- None
Request URL
/v1/paypro/payinApi
Request Method
- POST
Header
Header | Required | Type | Description |
---|---|---|---|
merchantNo | Yes | string | - |
Body
Parameter Name | Required | Type | Description |
---|---|---|---|
sign | Yes | string | Except for the sign, concatenate the remaining fields in alphabetical order to form key1=value1key2=value2, then use the app secret as salt to perform MD5 encryption. The sign should be in lowercase letters. |
timestamp | Yes | String | Timestamp (e.g., 1715941383720) |
amount | Yes | string | Payment amount (amounts with decimals are not recommended) |
tradeNo | Yes | string | Transaction number (should be unique; suggested format: YYYYMMDDHHMMSS + random number) |
name | Yes | string | Payer's name |
mobile | Yes | string | Mobile number of the payee (10 digits beginning with 6, 7, 8, or 9; omit the 91 country code). |
Yes | string | Payer's email (should use gmail.com domain, e.g., abc@gmail.com) | |
ipAddress | Yes | string | Payer's ipAddress |
remark | No | string | Remarks; this field will be returned as is |
notifyUrl | Yes | string | Asynchronous callback URL (e.g., https://www.abc.com/); if not provided, the system will redirect to the default success page |
returnUrl | Yes | string | Redirect page after successful payment |
Request Parameter Example
{
"sign": "f53ee692f15d0329a1461373b67ff25a",
"timestamp": "1724142041682",
"tradeNo": "00000007",
"amount": "300",
"name": "abc",
"mobile": "918234567890",
"email": "123@qq.com",
"ipAddress": "14.155.28.59",
"remark": "000000",
"notifyUrl": "https://google.com",
"returnUrl": "http://abc.com/callback_page"
}
Response Result
Parameter Name | Required | Type | Description |
---|---|---|---|
msg | Yes | string | Request result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic) |
code | Yes | string | Request response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic) |
timestamp | Yes | string | Transaction time |
success | Yes | string | Transaction result |
data | Yes | Object | Response object |
data.platFormTradeNo | Yes | string | Unique paypro transaction number |
data.paymentInfo | Yes | string | Payment information, payment link, or QR code information |
data.status | Yes | string | Request result; merchants can use this for logical processing. "0000" indicates transaction success, "0015" indicates processing, and other codes are error codes that can be treated as failures. |
data.desc | Yes | string | Error description |
data.remark | Yes | string | Returned content of the request (returned as is) |
data.upi | Yes | string | UPI Payment link. |
data.phonepe | Yes | string | PHONEPE Payment link. |
data.paytm | Yes | string | PAYTM Payment link. |
data.gpay | Yes | string | GPAY Payment link. |
Successful Response Example
{
"msg": "success",
"code": "0000",
"timestamp": 1719829837779,
"success": true,
"data": {
"platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
"status": "0015",
"desc": "CREDIT_INPROGRESS",
"remark": "000000",
"upi": "upi://pay?pa=neo.intromaximme@finobank&pn=INTROMAX%20IMMEDIATE%20PRIVATE%20LIMITED&mc=5691&tr=NKFV2g6KiCZuCPD3mmfC1j6bwk7&tn=orderId&am=10000&cu=INR&mode=05&orgid=187064&catagory=01&sign=MEYCIQCZ1V12elzZuhSCDZBYtK4lzViCzePMbHPoVjzLK5kxfgIhAJprtHgTJ7TpoGDf5+LTz+Jzi2xqSJ6Hmsc28+LjwBlG",
"phonepe": "phonepe://pay?pa=neo.intromaximme@finobank&pn=INTROMAX%20IMMEDIATE%20PRIVATE%20LIMITED&mc=5691&tr=NKFV2g6KiCZuCPD3mmfC1j6bwk7&tn=orderId&am=10000&cu=INR&mode=05&orgid=187064&catagory=01&sign=MEYCIQCZ1V12elzZuhSCDZBYtK4lzViCzePMbHPoVjzLK5kxfgIhAJprtHgTJ7TpoGDf5+LTz+Jzi2xqSJ6Hmsc28+LjwBlG",
"paytm": "paytmmp://pay?pa=neo.intromaximme@finobank&pn=INTROMAX%20IMMEDIATE%20PRIVATE%20LIMITED&mc=5691&tr=NKFV2g6KiCZuCPD3mmfC1j6bwk7&tn=orderId&am=10000&cu=INR&mode=05&orgid=187064&catagory=01&sign=MEYCIQCZ1V12elzZuhSCDZBYtK4lzViCzePMbHPoVjzLK5kxfgIhAJprtHgTJ7TpoGDf5+LTz+Jzi2xqSJ6Hmsc28+LjwBlG",
"gpay": "gpay://upi/pay?pa=neo.intromaximme@finobank&pn=INTROMAX%20IMMEDIATE%20PRIVATE%20LIMITED&mc=5691&tr=NKFV2g6KiCZuCPD3mmfC1j6bwk7&tn=orderId&am=10000&cu=INR&mode=05&orgid=187064&catagory=01&sign=MEYCIQCZ1V12elzZuhSCDZBYtK4lzViCzePMbHPoVjzLK5kxfgIhAJprtHgTJ7TpoGDf5+LTz+Jzi2xqSJ6Hmsc28+LjwBlG",
}
}