订单取消接口
功能描述
商户可以通过此接口取消尚未打款的订单。请注意，涉及CNY币种的交易无法进行取消。
接口地址
https://apis.geoswift.com/remittance/cancel
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| merchantId |
商户编号 |
varchar(9) |
商户在汇元通系统的唯一id，可在商户后台查看 |
M |
| requestId |
订单取消请求号 |
varchar(50) |
订单取消请求号为商户自行拟定，提交的订单取消请求号必须在自身平台交易中唯一。汇元通系统成功或失败的订单取消请求，商户平台不能以相同的订单取消请求号再次提交。 |
M |
| remittanceRequestId |
原交易商户订单号 |
varchar(50) |
原交易商户订单号 |
M |
| proxyRequestId |
拓展请求号1 |
varchar(50) |
拓展请求号1 |
O |
| merchantReference |
拓展请求号2 |
varchar(50) |
拓展请求号2 |
O |
| remark |
备注 |
varchar(200) |
备注 |
O |
| partnerId |
服务商 id |
varchar(9) |
二级商户上属服务商商户在汇元通系统 的唯一身份标识（如果发起商户自身即为 主商户此项可不传） |
C |
| hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 |
M |
参数示例
<![CDATA[
{
"merchantId": "G90008001",
"remittanceRequestId": "1651117930558",
"requestId": "1651118067786",
"hmac": "Jdajc8mMqY9p2Syyf5joaBam2S9PLD9InmJP+pLIaCpKn+BA/UNeXK+YhFrYoleS8PwzWUOSiDH7gKen8SHCF5v
Ci5WEXdb3t7wThra9Feo1wb3ytg1oNiBcpdUpJDcsE9rfoGSlgc4YkWilB0ki7o0CB0U0/MxBiLrsevE1KiR4N324XaT5akm
381CbIJtNSkvi3x+UCFUh8aN84exgo5z+P38TQLSQd7eZAJ+LpHGWjfvMNOX8Y++CE2LQMXbNxN4OlZlYXmkbZYRb84iz+dzbP
DhUfEmjyOghh1ejQPqGEWMIl3nIkVc1N/hSF4KIeGgv3JauqfNCWt9BcwCTEA=="
}
]]>
返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
同请求参数 |
| requestId |
订单取消请求号 |
同请求参数 |
| remittanceRequestId |
原交易商户订单号 |
同请求参数 |
| proxyRequestId |
拓展请求号1 |
同请求参数 |
| merchantReference |
拓展请求号2 |
同请求参数 |
| status |
请求状态 |
SUCCESS 成功 |
| FAILED 失败 |
| ERROR 错误 |
| cancelStatus |
取消状态 |
INIT 初始化 |
| PROCESS 处理中 |
| SUCCESS 成功 |
| FAILED 失败 |
| createDateTime |
创建时间 |
订单取消创建时间 |
| completeDateTime |
完成时间 |
订单取消完成时间 |
| remark |
备注 |
备注 |
| errorCode |
错误码 |
错误码，订单取消失败时返回 |
| errorMsg |
错误描述 |
错误描述，订单取消失败时返回 |
| partnerId |
服务商 id |
同请求参数 |
| hmac |
参数签名 |
汇元通生成的参数签名结果，验签过程请参考解密流程 |
示例
<![CDATA[
{
"cancelStatus": "SUCCESS",
"completeDateTime": "2022-04-28 11:54:39",
"createDateTime": "2022-04-28 11:54:39",
"hmac": "Jdajc8mMqY9p2Syyf5joaBam2S9PLD9InmJP+pLIaCpKn+BA/UNeXK+YhFrYoleS8PwzWUOSiD
H7gKen8SHCF5vCi5WEXdb3t7wThra9Feo1wb3ytg1oNiBcpdUpJDcsE9rfoGSlgc4YkWilB0ki7o0CB0U
0/MxBiLrsevE1KiR4N324XaT5akm381CbIJtNSkvi3x+UCFUh8aN84exgo5z+P38TQLSQd7eZAJ+LpHGWjfv
MNOX8Y++CE2LQMXbNxN4OlZlYXmkbZYRb84iz+dzbPDhUfEmjyOghh1ejQPqGEWMIl3nIkVc1N/hSF4KIeGgv3JauqfNCWt9BcwCTEA==",
"merchantId": "G90008001",
"merchantReference": "",
"proxyRequestId": "",
"remark": "",
"remittanceRequestId": "1651117930558",
"requestId": "1651118067786",
"status": "SUCCESS"
}
]]>