PaymentPage API

PaymentPage API redirects users to a predefined payment page. This simplifies the process for clients as they do not need to manage the payment flow themselves; everything is handled by the PSP.

Tips

All requests are Post requests, and the data format is json

API Documentation for Payment Link Interface

Brief Description

Cashier payment interface.

Request URL

/v1/paypro/paymentLink

Request Method

POST

Collection Method Codes

wayCode	Description
store	Convenience store
va	Va repayment (CLABE)

Header	Required	Type	Description
merchantNo	Yes	string	-

Body

Parameter Name	Required	Type	Description
sign	Yes	string	Except for sign, the remaining fields are sorted by the first letter to form key1=value1key2=value2, then use app secret as salt for MD5 encryption. The sign should be in lowercase letters.
timestamp	Yes	long	Timestamp (e.g., 1715941383720)
tradeNo	Yes	string	Transaction number (should be unique, suggested format: YYYYMMDDHHMMSS + random number)
amount	Yes	string	Amount (no decimal support)
mobile	No	string	User's mobile phone number
email	No	string	Email address
payer	No	string	Payer's name
wayCode	No	string	Collection method code
notifyUrl	Yes	string	Asynchronous callback URL
returnUrl	No	string	Cashier page redirect URL, remove escape characters “\”, reference format: https://www.abc.com/. If not provided, it will redirect to the system's default success page.
remark	No	string	Remark, this field will be returned as is.

Request Parameter Example

{
  "sign": "0be92a962072b1786a01a2cab4891a1d",
  "timestamp": "1728609257212",
  "tradeNo": "test_00000008",
  "amount": "300",
  "mobile": "15745896325",
  "email": "[email protected]",
  "payer": "kevin zhang",
  "wayCode": "va",
  "notifyUrl": "https://google.com",
  "returnUrl": "http://abc.com/callback_page",
  "remark": "test"
}

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
data.platFormTradeNo	Yes	string	PayPro transaction number, unique
data.status	Yes	string	Request result. The merchant can use this for logical processing. "0000" indicates transaction success, "0001" indicates partial payment, "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.paymentUrl	Yes	string	Payment link, i.e., the cashier 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"
    }
}