关闭订单
本章主要介绍关闭订单接口,商户可以调用该接口关闭订单。
应用场景
需要调用关闭订单接口的场景如下:
- 商户订单支付失败,需要生成新订单号重新发起支付,请对原订单调用关闭订单接口,避免重复支付。
- 系统下单后,用户支付超时,商户不再受理,避免用户继续支付,请调用关闭订单接口。
接口描述
- URL 地址:https://api.edgeros.com/pay/v1/transactions/close。
- 传参方式:body(JSON 格式)。
- 是否需要签名:需要,详情请参见 生成数字签名。
请求参数
字段名 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
transaction_no | String(50) | 否 | AP202112151150252267829842920145605378 | 翼辉支付订单号,与商户订单号二选一,不能同时为空,同时存在时,以翼辉支付订单号做关闭订单处理 |
mch_trade_no | String(50) | 否 | mp202104021606341385640107521832 | 商户订单号,与翼辉支付订单号二选一,不能同时为空,同时存在时,以翼辉支付订单号做关闭订单处理 |
aco_pay_sdk | String(12) | 否 | 2.0.0 | 翼辉支付 Java SDK 的版本号 |
version | String(3) | 否 | 1.0 | 调用接口版本,固定值 1.0 |
请求示例
{
"transaction_no": "AP202112151150252267829842920145605378",
"mch_trade_no": "mp202104021606341385640107521832",
"aco_pay_sdk": "2.0.0",
"version": "1.0"
}
响应参数
字段名 | 类型 | 示例值 | 说明 |
---|---|---|---|
status | int | 200 | 返回状态码 |
message | String(100) | SUCCESS | 返回信息,取值为 SUCCESS 表示调用成功,其余均为调用失败,详情请参见 错误码 |
fieldErrors | String(50) | 此订单不存在 | 异常信息,当 message 不为 SUCCESS 时,返回具体错误原因 |
data | object | "data": {} | 具体业务返回信息 |
status
为 200 时,data
返回如下字段:
字段名 | 类型 | 示例值 | 说明 |
---|---|---|---|
mch_no | String(32) | MCH1000000 | 翼辉支付平台分配的商户号 |
nonce | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,长度不大于 32 位 |
sign | String(344) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,商户需要验证签名,详情请参见 验证数字签名 |
sign_type | String(20) | SHA256withRSA | 签名类型,目前支持 SHA256withRSA |
mch_trade_no | String(50) | mp202104021606341385640107521832 | 商户订单号 |
transaction_no | String(50) | 4af336b1bd904c69ab2edb76af3a2a35 | 翼辉支付订单号 |
code | String(20) | FAIL | 业务状态代码 |
description | String(200) | 订单已过期 | 业务状态代码描述 |
响应示例
正确响应示例
{
"status": 200,
"message": "SUCCESS",
"fieldErrors": null,
"data": {
"mch_no": "MCH1000000",
"nonce": "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
"sign": "C380BEC2BFD727A4B6845133519F3AD6",
"sign_type": "SHA256withRSA",
"mch_trade_no": "mp202104021606341385640107521832",
"transaction_no": "4af336b1bd904c69ab2edb76af3a2a35",
"code": "FAIL",
"description": "订单已过期"
}
}
错误响应示例
{
"status": 1007,
"message": "ORDER_NOT_EXIST",
"fieldErrors": "此订单不存在!",
"data": {
"mch_no": "MCH1000000",
"sign_type": "SHA256withRSA",
"sign": "KO2Cn2ohFNN70aZIOiZRadTEqY5uzsdqT9c6YFzr1zZw68wqGurzjrV7IKEatfC/Isy++2ovI/Z6OJRNFrkpq2JDrf4ZgTXmK4msOtmEt/wmk/lNvbEPMIZE9UJcxo+3cmwVsofwI2ekSSbJKYpa1/S/aB6Ghieu3y1uQhd0OEw04MscmLmFVqs1B6soKHpXHr18BiR7xFXhw6EjTKQPsCTxtTr1KUYNweKv548mrdXB6SiPFW9vfq3o3QE/v4Kb7vhnzpBp4LzXn/Lxl/F7T3D9tfcnx50TLENCZWZcGa+IQ7c5dXhBiTelDQXnX8AjxlJ142lRpkLeqVwuc7XLfA==",
"nonce": "ECAvdtwizqXFaY6w5BBhPwP0j3MERf1O"
}
}