# 2. Check Payout Status

# Request URL
  • /api/v1/payout/check
# Request Method
  • GET
# Request Params
parameter name Is it mandatory type of data length example description
appId mandatory string - - application APPID
mchOrderId mandatory string 20 CCP20220428011068111 Merchant order id (unique for merchant)
sign mandatory string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 sign
# response params
parameter name type of data example description
code int 1000 Status code see reference
message String success The message of status code
data Object - Response Data
- mchOrderId String CCPL1653307140755313 Merchant order id (unique for merchant), 1-32 characters
- transactionId String D1007653307144580541 PayCools Unique transaction number
- amount long 2000000 Transaction amount, unit: cents
- transactionStatus String COMPLETE Transaction status
- createTime String 2022-05-23 19:59:05 Transaction create time
- returnTime String 2022-05-23 20:04:14 Transaction complete time
- remark String cash credit remark
- failedCode String 10000 Transaction failed code The reference list
- failedMessage String Transaction Service Error Transaction error message
# successful response example. transactionStatus see reference
{
  "code": 1000,
  "message": "success",
  "data": {
    "mchOrderId": "CCPL1653307140755313",
    "transactionId": "D1007653307144580541",
    "amount": 245500,
    "transactionStatus": "COMPLETE",
    "createTime": "2022-05-23 19:59:05",
    "returnTime": "2022-05-23 20:04:14",
    "remark": "cash credit",
    "failedCode": null,
    "failedMessage": null
  }
}
# failed response example
{
    "code":1002,
    "message":"merchant white ip forbidden",
}