Payment API
Tips
- All requests are
Post
requests, and the data format isjson
Brief Description
Request URL
/v1/paypro/payIn
Request Method
- POST
Header
header | Required | Type | Description |
---|---|---|---|
merchantNo | Yes | string | None |
Body
Parameter | Required | Type | Description |
---|---|---|---|
sign | Yes | string | Except for the sign field, all remaining fields should be sorted alphabetically by their first letter, combined into key1=value1key2=value2, and encrypted using the app secret as salt via MD5. The final sign value should be in lowercase. |
timestamp | Yes | long | Timestamp (1715941383720) |
payer | Yes | string | payer |
amount | Yes | string | Amount (adjustable from minimum 100 to maximum 10,000, decimal numbers not supported) |
remark | Yes | string | Remark, this field will be returned as-is |
tradeNo | Yes | string | Transaction number (uniqueness recommended: year, month, day, hour, minute, second + random number) |
mobile | Yes | string | Mobile phone number (Mobile phone number verification rule: The first 11 digits from 010 to 018 must be accurate; otherwise, it may affect the collection.) |
Yes | string | ||
notifyUrl | Yes | string | Asynchronous callback URL |
returnUrl | No | string | casher jump url |
Request Parameter Example
{
"sign": "0be92a962072b1786a01a2cab4891a1d",
"timestamp": "1728609257212",
"tradeNo": "test_00000008",
"payer": "kevin zhang",
"amount": "300",
"mobile":"6789123456",
"email": "sdkjfksdjfk@gmail.com",
"notifyUrl": "https://google.com",
"returnUrl": "http://abc.com/callback_page",
"remark":"test"
}
Response Result
Parameter | Required | Type | Description |
---|---|---|---|
msg | Yes | string | Request result (when returning success, it only indicates that the request was successful and cannot be used for merchant-side logic judgment) |
code | Yes | string | Request response code (when returning 0000, it only indicates that the request was successful and cannot be used for merchant-side logic judgment). For specific error codes, please refer to the business error code enumeration. |
timestamp | Yes | string | Transaction time |
success | Yes | string | Transaction result |
data | Yes | Object | Return object |
data.tradeNo | Yes | string | merchant request trade no |
data.platFormTradeNo | Yes | string | Paypro transaction number, unique |
data.status | Yes | string | Request result. Merchants can use it as a logic process. When the result is 0000, it means the transaction is successful, 0001 means partial payment, 0015 means in processing, and other codes are error codes and can be treated as failures. |
data.desc | Yes | string | Error description |
data.remark | Yes | string | The returned content of the request (returned in the original path) |
data.paymentUrl | Yes | string | pay url |
Successful Response Example
{
"msg": "success",
"code": "0000",
"timestamp": 1728609277476,
"success": true,
"data": {
"tradeNo": "test_00000008",
"platFormTradeNo": "68o0uwogz7mnzutt",
"status": "0015",
"desc": "Create",
"remark": "test",
"paymentUrl": "https://checkout.tpservice.vip/#/order/bd/P1844547116046675970"
}
}