# 2. Check Payout Status

# Request URL

  • {domain}/open-api/disbursement/check

# Request Method

  • POST

# Request Body

Parameter Name Required Type Description
appId Y string application ID
param Y string param (Json String)
sign Y string sign

# param

Parameter name Required Type Length Example Description
mchOrderId Y string 1-32 - mch order id
timestamp Y long - 1677495496979 time stamp

# Request Body Example

{
    "appId": "733b887a4a784708bb369524db5b6ded",
    "sign": "Platform",
    "param": "{\"mchOrderId\":\"MCHORDERIDC00001\",\"timestamp\":\"1677133173758\"}"
}

How to construct request body


# Response Param

Parameter Name Type Description
code integer response code
message string response message
data Object data

# data

Parameter Name Type Example Description
mchOrderId String - Merchant order id (unique for merchant)
transactionId String D1656505190221611009 Platform Unique transaction number
amount long 3000 Transaction amount, unit: cents
transactionStatus String Reference List Transaction status
createTime String 2023-05-04 11:43:08 Transaction create time
returnTime String - Transaction COMPLETED time
remark String COMPLETED Remark
failedCode String Reference List Transaction failed code
failedMessage String - Transaction error message

# Response Example

# Response Param

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "MCHORDERIDC00001",
    "transactionId": "D1656505190221611008",
    "amount": 3000,
    "transactionStatus": "FAILED",
    "createTime": "2023-05-04 11:43:08",
    "returnTime": "2023-05-04 11:43:47",
    "failedCode": -10004,
    "failedMessage": "Transaction Channel Rejected"
  }
}

Code Collection

# Failed Response Example

{
    "code": 21010,
    "message": "transaction not found",
    "data": null
}