# 2. Query Disbursement Status Interface

# Brief Description

  • Merchant disbursement - query interface

# Request URL

  • /api/v1/payout/check

# Request Method

  • GET

# Request Parameters

Parameter Name Required Type Length Limit Example Description
appId Yes string - - Application APPID
mchOrderId Yes string - CCP20220428011068111 Merchant order ID
sign Yes string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 Signature

# Response Parameters

Parameter Name Type Description
code int Status code
message string Status message
data object Response data

# data Parameters

Parameter Name Type Example Description
mchOrderId String CCPL1653307140755313 Merchant order number
transactionId String D1007653307144580541 Paycools system order number, unique identifier in Paycools system
amount long 2000000 Transaction amount, unit: cents
transactionStatus String COMPLETE Transaction status
createTime String 2022-05-23 19:59:05 Transaction creation time
returnTime String 2022-05-23 20:04:14 Transaction completion time
remark String cash credit Remark
failedCode String 10000 Transaction error code Reference List
failedMessage String Transaction Service Error Transaction error message

# Response Example transactionStatus Reference List

{
  "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
  }
}

# Response Failure Example see reference

{
  "code": 1002,
  "message": "merchant white ip forbidden"
}