分账退款登记接口
1.修订记录
| 修订 | 日期 | 说明 | 作者 |
|---|---|---|---|
| V0.1 | 2018/10/30 | 新接口参数定义 | 罗华仪 |
| V0.2 | 2020/11/11 | 修改ACQ_QUERY_NO_RECORD的说明 | 汤吉齐 |
| V0.3 | 2021/01/21 | 修改ACQ_QUERY_NO_RECORD的描述 | 王晶 |
| V0.4 | 2021/12/27 | 支持国密 | 王晶 |
2.接口说明
（1）场景说明
1、对完成分账的交易，进行退款登记
（2）接口说明
1、分账退款登记接口
3.请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.ysepay.com/gateway.do |
4.请求参数说明
4.1 公共请求参数
| 参数 | 类型(字节长度） | 必填 | 参数说明 |
|---|---|---|---|
| method | String(128) | Y | 接口名称 固定值 ysepay.online.trade.refund.split.register |
| partner_id | String(20) | Y | 在银盛支付开设的服务商商户号，请联系客户经理提供 |
| timestamp | String(19) | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 示例值：2014-07-24 03:07:50 |
| charset | String(10) | Y | 商户网站使用的编码格式，如UTF-8、GBK、GB2312等，默认值 GBK |
| sign_type | String(10) | Y | 报文签名算法，RSA/SM |
| sign | String(256) | Y | 签名字符串，再用Base64编码 |
| version | String(3) | Y | 接口版本3.0 当前版本：3.0 |
| notify_url | String(190) | Y | 银盛支付服务器主动通知商户网站里指定的页面http路径，需要支持TLS1.0或TLS1.1 |
| tran_type | String(1) | N | 交易类型，说明：1或者空：非担保交易，2：担保交易，无特殊需求 不用填此字段 |
| biz_content | String | Y | 业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 | 类型(字节长度） | 必填 | 参数说明 |
|---|---|---|---|
| out_trade_no | String(1,32) | Y | 商户原交易订单号, 示例值：201805256843192280647118 |
| shopdate | String(8,8) | Y | 商户系统的交易发生日期格式yyyyMMdd 示例值：20180525 |
| trade_no | String(1，30) | C | 银盛原交易流水号 示例值：311160414497667096 |
| refund_amount | Number(10,2) | Y | 需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数，Number(10,2)指10位长度，2位精度 |
| refund_reason | String(1，50) | Y | 退款的原因说明，该参数最长为50个汉字。 |
| out_request_no | String(1，32) | Y | 商户系统生成的退款订单号，标识一次退款请求，同一笔交易多次退款需要保证唯一。该参数支持汉字，最大长度为16个。示例值：RD2012061713107 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 | 类型(字节长度） | 必填 | 参数说明 |
|---|---|---|---|
| sign | String | Y | 签名字符串，Base64编码 |
| ysepay_online_trade_refund_split_register_response | String | Y | 业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
| 参数 | 类型(字节最大长度） | 必填 | 参数说明 |
|---|---|---|---|
| code | String | Y | 响应代码 |
| msg | String | Y | 响应代码描述 |
| trade_no | String(1，30) | Y | 银盛支付平台的原订单交易流水 示例值：311160414497667096 |
| out_trade_no | String(1，32) | Y | 订单支付时传入的商户订单号 示例值：68431922806471166 |
| trade_status | String(30) | Y | 登记目前所处的状态。SUCCES：登记成功 ；FAILED：登记失败 |
| sub_msg | String(50) | N | 返回描述 |
6.样例
无
7.附录
7.1 分账退款登记请求错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| ACQ.SYSTEM_ERROR | 系统内部错误 | 请使用相同的参数再次调用 |
| isv.missing-notifyurl | 缺少异步通知地址 | 请填入正确的异步通知地址 |
| ACQ.REFUND_AMT_NOT_EQUAL_ORDER_AMT | 退款金额与订单金额不等 | 检查退款金额与订单金额是否退款，确认后重新发起 |
| ACQ.REFUND_SRC_NOT_EQUAL_ORDER_SRC | 退款发起方与原交易发起方不一致 | 检查退款发起方与原交易发起方是否一致，确认后再重新发起 |
| ACQ.ORIGINAL_ORDER_STATE_ERROR | 原订单交易状态不支持分账退款登记 | 检查原订单交易状态是否正确，确认后再重新发起 |
| ACQ.QUERY_NO_RECORD | 暂未查询到交易，请检查订单号/流水号后重试 | 该状态为未知状态，请勿当成失败状态处理 检查传入的订单号是否正确，修改后重新发起请求或继续查询 |