Payment API
Tips
- All requests are
Postrequests, and the data format isjson
Brief Description
- None
Request URL
/v1/paypro/payin
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 | long | Timestamp (e.g., 1715941383720) |
| amount | Yes | string | Payment amount |
| wayCode | Yes | string | Supported payment types: • E-wallet: BKASH、NAGAD |
| tradeNo | Yes | string | Transaction number (should be unique; suggested format: YYYYMMDDHHMMSS + random number) |
| 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 | No | string | Redirect page after successful payment |
Request Parameter Example
{
"sign": "0be92a962072b1786a01a2cab4891a1d",
"timestamp": "1728609257212",
"tradeNo": "test_00000008",
"amount": "300",
"notifyUrl": "https://google.com",
"wayCode":"EWALLET_BKASH",
"remark":"test",
"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.tradeNo | Yes | string | Merchant transaction number returned |
| data.platFormTradeNo | Yes | string | Unique paypro transaction number |
| 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.paymentLink | Yes | string | Payment link, i.e., the cashier URL |
Successful Response Example
{
"msg": "success",
"code": "0000",
"timestamp": 1728609277476,
"success": true,
"data": {
"kiliTradeNo": "68o0uwogz7mnzutt",
"status": "0015",
"desc": "Create",
"remark": "test",
"paymentLink": "https://checkout.tpservice.vip/#/order/bd/P1844547116046675970"
}
}
