订单撤单
当用户在商户方发起撤单操作时调用该接口撤销订单支付
1.接口说明
订单撤单
2.业务时序图
3.接口定义
path | 请求方式 | 接口描述 | 调用权限 |
---|---|---|---|
/pay/cancel | POST | 订单撤单 | 第三方支付角色 |
4.请求头说明
名称 | 是否必须 | 类型 | 默认值 | 备注 |
---|---|---|---|---|
Content-Type | true | string | application/json | N/A |
5.请求参数说明
名称 | 是否必须 | 类型 | 传值范围 | 默认值 | 备注 |
---|---|---|---|---|---|
merchantNo | true | string | 3~32(字符长度) | N/A | 商户号 |
paymentOrderNo | true | string | 3~32(字符长度) | N/A | 支付单号 |
cancelNo | true | string | 3~32(字符长度) | N/A | 撤销单号 |
请求示例:
{
"merchantNo": "MCH0001",
"paymentOrderNo": "PAY201906059985220002",
"cancelNo": "C201905644065650"
}
6.返回参数说明
名称 | 是否必须 | 类型 | 备注 |
---|---|---|---|
ret | true | string | 请求是否正常返回状态码:"-1"请求异常 ,"0":请求成功 |
errorCode | true | string | 请求成功返回null,失败返回code码 |
msg | true | string | 成功返回"ok",失败返回错误信息 |
success | true | boolean | 成功返回true,失败返回false |
data | false | object | 成功返回数据主体,失败不返回 |
paymentOrderNo | 依赖data字段 | string | 支付单号 |
cancelNo | 依赖data字段 | string | 撤销单号 |
status | 依赖data字段 | string | 撤单结果:0(撤单失败)、1(撤单成功) |
serialNo | 依赖data字段 | string | 流水号 |
返回示例:
{
"ret": "0",
"errorCode": null,
"msg": "ok",
"success": true,
"data": {
"paymentOrderNo": "3223243543545435",
"cancelNo": "3223243543545435",
"paymentOrderNo": "3223243543545435",
"status": 1,
"serialNo": "322324354354543511"
}
}