Payout API

Tips

Payout API is used to initiate transfer requests to e-wallets or bank accounts.

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

Request URL

/v1/paypro/payOut

Request Method

POST

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)
customerName	Yes	string	customerName
amount	Yes	string	Payment amount (adjustable from a minimum of 100 to a maximum of 10,000, no decimal points 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)
notifyUrl	Yes	string	Asynchronous callback URL
walletId	Yes	string	wallet id（Receiving account）

Request Parameter Example

{
  "sign": "b39f64dc1586867b1966a569ba06e3a2",
  "timestamp": "1728611780130",
  "tradeNo": "test_00000001",
  "walletId": "01123456789",
  "customerName": "kevin",
  "amount": "300",
  "notifyUrl": "https://google.com",
  "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": 1728611805322,
    "success": true,
    "data": {
		"tradeNo": "test_111",
        "platFormTradeNo": "2tjba3vz6wm6hx3l",
        "status": "0015",
        "desc": "CREATED",
		"remark":"test"
    }
}