# Dispute query
Merchants can query disputed order details through this interface and obtain the latest status and processing progress of the dispute.
# Dispute query interface
interface
Request API: /api/pay/dispute/query
Request method: POST
Request type: application/json or application/x-www-form-urlencoded
# Request parameters
| Field name | Variable name | Required | Type | Sample value | Description |
|---|---|---|---|---|---|
| Merchant Number | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Dispute ID | disputeId | No | String(30) | D202512101104177050001 | Platform dispute ID, which can be passed together with payOrderId |
| Payment order number | payOrderId | No | String(30) | P20160427210604000490 | The order number generated by the payment center, and the disputeId can be passed together |
| Request time | reqTime | Yes | long | 1622016572190 | Request interface time, 13-digit timestamp |
| Interface version | version | Yes | String(3) | 1.0 | Interface version number, fixed: 1.0 |
| Signature | sign | Yes | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | Signature value, see signature algorithm for details |
| Signature type | signType | Yes | String(32) | MD5 | Signature type, currently only supports MD5 mode |
# Request sample data
{
"disputeId": "D202512101104177050001",
"appId": "60cc09bce4b0f1c0b83761c9",
"sign": "46940C58B2F3AE426B77A297ABF4D31E",
"signType": "MD5",
"reqTime": "1622016572190",
"mchNo": "M1623984572",
"version": "1.0"
}
# Return parameters
| Field name | Variable name | Required | Type | Sample value | Description |
|---|---|---|---|---|---|
| Return status | code | Yes | int | 0 | 0 - processing successful, others - processing error, see error code for details |
| Return information | msg | No | String(128) | Signature failure | Specific error reasons, such as: signature failure, parameter format verification error |
| Signature information | sign | No | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | Sign the data in data, if data is empty, it will not be returned |
| Return data | data | No | String(512) | {} | Return disputed data, json format data |
# data data format
| Field name | Variable name | Required | Type | Sample value | Description |
|---|---|---|---|---|---|
| Dispute ID | disputeId | Yes | String(30) | D202512101104177050001 | Platform dispute ID |
| Payment order number | payOrderId | Yes | String(30) | P12021022311124442600 | Associated payment system order number |
| Merchant Number | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Disputed amount | amount | Yes | long | 100 | Disputed amount, unit cent |
| Currency code | currency | Yes | String(3) | USD | Three-digit currency code |
| Dispute stage | stage | Yes | String(50) | first_chargeback_under_review | Dispute stage |
| Reason Code | reasonCode | No | String(32) | 10.4 | Dispute reason code returned by the channel |
| Reason description | reasonMsg | No | String(256) | Fraud | Description of the dispute reason returned by the channel |
| Response deadline | responseDeadline | No | long | 1622016572190 | Response deadline, 13-digit timestamp |
| Signature | sign | Yes | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | Signature value, see signature algorithm for details |
| Field name | Variable name | Required | Type | Sample value | Description |
# Return sample data
{
"code": 0,
"data": {
"amount": 100,
"appId": "60cc09bce4b0f1c0b83761c9",
"createdAt": 1623985457705,
"currency": "USD",
"disputeId": "D202512101104177050001",
"mchNo": "M1621873433953",
"payOrderId": "P20160427210604000490",
"stage": "first_chargeback_under_review",
"reasonCode": "10.4",
"reasonMsg": "Fraud",
"responseDeadline": 1624590257000
},
"msg": "SUCCESS",
"sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}