# 4. Disburse callback notification api

# description
  • Disburse callback api
# Request URL
  • /xxx
# request method
  • POST
# request params
parameter name Is it mandatory type of data description
mchOrderId mandatory string Merchant ID
transactionId mandatory string PayCools Transaction ID
amount mandatory int Amount
transactionStatus mandatory string Transaction Status:PENDING,COMPLETE,FAILED
eventName mandatory string Event Name(1.disbursement.success 2.disbursement.failed)
sign mandatory string Sign
createTime mandatory string Create Time
returnTime mandatory string Return Time
failedCode optional int Failed Code
failedMessage optional string Failed Message
remark optional string Remark
# callback example
// payout success example
{
    "amount":312500,
    "createTime":"2022-05-31 09:38:03",
    "eventName":"disbursement.success",
    "mchOrderId":"CQPL1653961082230623",
    "remark":"cash credit",
    "sign": "xxxxxxxxxxxxx",
    "returnTime":"2022-05-31 09:38:56",
    "transactionId":"D1032653961082864323",
    "transactionStatus":"COMPLETE"
}

// payout failed example
{
    "amount":312500,
    "createTime":"2022-05-31 09:37:20",
    "eventName":"disbursement.failed",
    "failedCode":-10001,
    "failedMessage":"Transaction Exceed Limit",
    "mchOrderId":"CQPL1653961039756685",
    "remark":"cash credit",
    "sign": "xxxxxxxxxxxxx",
    "returnTime":"2022-05-31 09:38:15",
    "transactionId":"D1001653961040053795",
    "transactionStatus":"FAILED"
}
# 返回示例
{
    "code":1,
    "msg":"success",
    "data":{
	}
}