商户可以通过退款接口将支付金额退还给用户,慧收钱将在收到退款请求并且验证成功之后,请求渠道将支付款原路退还至用户账户。
接口说明
测试请求URL:https://test-api.huishouqian.com/api/acquiring
生产请求URL:https://api.huishouqian.com/api/acquiring
请求方式:POST
公共请求参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
method | 方法名 | string[1,32] | 是 | POLYMERIZE_REFUND |
version | 版本 | string[1,16] | 是 | 接口版本:1.0 |
format | 请求格式 | string[1,16] | 是 | 业务请求参数格式,支持:JSON |
merchantNo | 商户号 | string[1,16] | 是 | 商户在慧收钱的商户号,由慧收钱生成并下发 |
signType | 加密类型 | string[1,16] | 是 | RSA2:签名机制查看说明 |
signContent | 业务数据 | string | 是 | 业务请求参数 |
sign | 签名数据 | string[1,128] | 否 | 签名数据 |
业务请求参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
transNo | 商户订单号 | string[1,64] | 是 | 退款请求商户订单号,唯一不重复 |
refundType | 退款类型 | string[1,10] | 是 | 类型:1 |
origTransNo | 原商户订单号 | string[1,64] | 是 | 原支付交易对应的商户订单号 |
origOrderAmt | 原订单金额 | string[1,16] | 是 | 原支付交易的订单总金额,单位:分 示例:1 表示 1 分 |
orderAmt | 退款金额 | string[1,16] | 是 | 退款金额,累计退款交易不能超过原订单支付金额,单位:分 |
requestDate | 请求时间 | string[1,16] | 是 | 请求时间,与当前系统时间相差小于10分钟,格式[yyyyMMddHHmmss] 示例:20190101140908 |
refundReason | 退款原因 | string[1,128] | 是 | 退款原因 示例:商品已售完 |
returnUrl | 后端通知地址 | string[1,128] | 否 | 当退款有结果时,慧收钱主动通知商户的地址 示例:https://www.merchant.com/xxx |
extend | 附加字段 | string[1,128] | 否 | 附加数据,原样返回,可作为自定义参数使用 |
公共请求示例
{method=POLYMERIZE_REFUND, format=json, signType=RSA2, signContent=【参考业务请求示例】,sign=7ecbad9cb113bd54e6ee45f7fe76883a40428d548b7294ce8f7ba30f211881073820d3ec7a54d3406dcf7a4d3f87f0994c24db54bab430777425147378dbf01afe0491a1c287e5ce380454b0e228a5a20d541874c14addd4100199660e6c4a857fa080ceb4601a0ee21e3fab9d87016198f151a3b16f60a254c1e8b4cd42cdf7, version=1.0, merchantNo=814000473149}
业务请求示例
{
"extend":"自定义参数",
"refundType":"1",
"refundReason":"测试",
"requestDate":"20210812103012",
"origOrderAmt":"1",
"orderAmt":"1",
"transNo":"DD20210812103012841",
"returnUrl":"https://www.merchant.com",
"origTransNo":"DD20210812102555029"
}
公共响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
success | 响应状态 | string[1,32] | 是 | 服务端响应状态,如果为true,则可以调用result;如果为false,则调用errorCode来获取出错信息 |
errorCode | 错误码 | string[1,32] | 否 | 响应码 |
errorMsg | 错误描述 | string[1,128] | 否 | 响应描述 |
result | 响应内容 | string | 否 | 业务响应参数 |
sign | 签名数据 | string[1,128] | 否 | 响应验签数据 |
业务响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
merchantNo | 商户号 | string[1,16] | 是 | 商户在慧收钱的商户号,由慧收钱生成并下发 |
transNo | 商户订单号 | string[1,64] | 是 | 退款请求的商户订单号 |
tradeNo | 交易订单号 | string[1,32] | 是 | 慧收钱系统交易订单号 |
orderAmt | 退款金额 | string[1,16] | 是 | 退款金额,单位:分 |
orderStatus | 退款状态 | string[1,16] | 是 | 退款状态,详见交易状态码 |
finishedDate | 完成时间 | string[1,14] | 否 | 退款完成时间,格式[yyyyMMddHHmmss] 示例:20190101140908 |
respCode | 响应码 | string[1,32] | 是 | 详见交易响应码 |
respMsg | 响应描述 | string[1,128] | 是 | 详见交易响应码 |
公共响应示例
业务响应示例
{
"finishedDate":"",
"merchantNo":"814000473149",
"orderAmt":"1",
"orderStatus":"PROCESSING",
"respCode":"100201",
"respMsg":"交易处理中,请稍后查询",
"tradeNo":"12000020210812102438004012382163",
"transNo":"DD20210812103012841"
}
交易状态码
状态码 | 描述 |
---|---|
INIT | 初始化 |
PROCESSING | 处理中 |
SUCCESS | 成功 |
FAIL | 失败 |
交易响应码
响应码 | 描述 | 解决方案 |
---|---|---|
200004 | 订单不存在 | |
200007 | 查询成功 | |
200008 | 查询失败 | |
200009 | 查询结果集为空 | |
200022 | 订单号有误或超过最大退款期限(365天)! |
作者:xiaochen 创建时间:2023-05-15 11:11
最后编辑:admin 更新时间:2024-10-21 15:45
最后编辑:admin 更新时间:2024-10-21 15:45