# 3. Disbursement Callback Notification Interface

# Brief Description

  • Disbursement callback interface

# Request URL - Merchant Backend Configuration

  • /xxx

# Request Method

  • POST

# Request Parameters

Parameter Name Required Type Description
mchOrderId Yes string Merchant order ID
transactionId Yes string Transaction ID
amount Yes int Amount
transactionStatus Yes string Event monitoring transaction status: PENDING, COMPLETE, FAILED
eventName Yes string Event name (1.disbursement.success 2.disbursement.failed)
sign Yes string Callback event signature
createTime Yes string Transaction creation time
returnTime Yes string Transaction completion time
failedCode No int Failure status code
failedMessage No string Failure status message
remark No string Remark

# Callback Example

// Disbursement 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"
}

// Disbursement failure 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"
}

# Merchant Response Format

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

# Response Example

{
  "code": 1,
  "msg": "success",
  "data": {}
}