订单关闭接口
功能概述
商户通过杰易收订单关闭接口关闭汇元通平台未支付的订单,目前仅支持微信扫码支付、微信 APP 支付的订单。当付款人长时间未支付后,为防止重复支付,商户可通过主动关闭订单来防止付款人继续支付该笔订单。
接口地址
https://apis.geoswift.com/cp/closeOrder
参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
merchantId |
商户编号 |
varchar(9) |
商户在汇元通系统的唯一身份标识,商户完成汇元通系统注册后可登录商户后台商户服务查看。 |
M |
partnerId |
服务商 ID |
varchar(9) |
服务商编号 |
C |
requestId |
订单关闭请求号 |
varchar(50) |
订单号为商户自行拟定,提交的请求号必须在自身平台交易中唯一。商户平台不能以相同的请求号再次提交。 |
M |
payOrderRequestId |
原交易商户订单号 |
varchar(50) |
需要关闭的原交易商户订单号 |
M |
remark |
备注 |
varchar(300) |
商户在汇元通为请求进行备注,同步返回给商户 |
O |
hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
M |
以上参数值中不能包含以下特殊字符’”&<>()
参数示例
{
"merchantId": "G90008002",
"requestId": "1616658567415",
"payOrderRequestId": "1616658528043",
"remark": "备注",
"hmac": "Q9ot1Fz+26rgNJYtcUvVK1GTkhXsOFGKW2iJ4Cntdchnn/trrpW6rDCIREVlZZdbbbt23Vn
quM6uxUEpip5X6BB2ft1X5F4KsGeqQsCdYN2Qt/Am5/P2mAaXE/E/z98NZO0wKbGxi5ZfZMYOYGfqzyh
Nou6AyUQvnqf5C9N0CaXTqGUYjg3dc4dlSPOjx/ez6/f4LNQ3z3dZfaM/DYuEnPIzjoTr9h7orYgsiBO
RPAUachK0q24yO7HTgbXu0XRwmiQ80SZjD9XtzOovsA3YXmwQKjIMOtcO49p4qxaKuHW1nAtAfcDsI43
lI/hCWJzCjpPhZBGWjTWaM6S18DQIvw=="
}
订单关闭返回参数列表
参数名称 |
参数中文名称 |
参数说明 |
merchantId |
商户编号 |
商户编号 |
partnerId |
服务商ID |
服务商编号 |
requestId |
订单号 |
订单关闭请求号 |
payOrderRequestId |
原交易商户订单号 |
原交易商户订单号 |
remark |
备注 |
备注 |
serialNumber |
流水号 |
订单关闭流水号 |
completeDateTime |
完成时间 |
订单关闭请求完成时间 |
status |
响应状态 |
成功 SUCCESS |
失败 FAILED |
错误 ERROR |
closeOrderStatus |
关闭订单状态 |
INIT 初始化 |
PROCESSING 处理中 |
SUCCESS 成功 |
FAILED 失败 |
errorMessage |
错误信息 |
错误信息 |
hmac |
参数签名 |
汇元通生成的参数签名结果,验签过程请参考解密流程 |
示例
{
"redirectUrl": "https://qa-gs-cashier.geoswift.com/receipt/redirect/index
/2c9980957a2c66a2017a2d17967b005b/2c9980957a2c66a2017a2d1796d1005e",
"serialNumber": "2c9980727a2c6c68017a2d1795490029",
"merchantId": "G90008005",
"requestId": "16242538053223",
"orderStatus": "PROCESSING",
"status": "REDIRECT",
"hmac": "uFzGnMExQgcCbxDjDbgjitCVK6+iD3qvxhQfk3DuDyfaJcXyiobyh8XBC4/jLpgF
SidLjxYXdnX9bP4iom3wStOOh05ohGWvYbdLHh31bKMmjITouKH05SfUOIno15vrENfUu8wbr
f0lIOx3tslTg2LAeAd+s9ekEVBq5ZvW06gKfOtmRzAtVTtT+weUxDo/R/vs7jK16rN3Gi4Jd6
YVmbPJFJCtkeGZJY1CkdfFFlYFoyIPY3/XvGUnw8KgAkQ8KlZIgzjWqBfiLyO7gcSWC1nybBK
tGTqdux2a/vinahPNcRdmN+BBauk65qaAEZnNaTLFsUtmc/b724P0PKKKKQ=="
}