退款接口
<h1>退款接口</h1>
<p><strong>接口说明</strong>
通用退款接口，可用于扫码支付（付款码支付、二维码支付），JSAPI支付，H5支付等退款</p>
<p><strong>接口地址</strong></p>
<p><code>https://cpay.xiangma365.com/xypay/v3/refundorder</code></p>
<p><strong>请求方式</strong></p>
<p><code>POST</code></p>
<p><strong>请求头部</strong></p>
<p><code>Content-Type:application/json</code></p>
<p><strong>请求参数</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">约束</th>
<th style="text-align: left;">描述</th>
<th style="text-align: left;">示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">inst_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">机构号 ，通道分配</td>
<td style="text-align: left;">60000001</td>
</tr>
<tr>
<td style="text-align: left;">mch_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">商户号</td>
<td style="text-align: left;">Y52212200002</td>
</tr>
<tr>
<td style="text-align: left;">refund_trace_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">请求流水号（系统方退款订单号）</td>
<td style="text-align: left;">31dafada31dskcada</td>
</tr>
<tr>
<td style="text-align: left;">refund_fee</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">退款金额，单位：分</td>
<td style="text-align: left;">100</td>
</tr>
<tr>
<td style="text-align: left;">pay_time</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">请求退款时间</td>
<td style="text-align: left;">2018116165053</td>
</tr>
<tr>
<td style="text-align: left;">trade_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">C</td>
<td style="text-align: left;">支付订单号</td>
<td style="text-align: left;">20000032114018111516011200013</td>
</tr>
<tr>
<td style="text-align: left;">pay_trace_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">C</td>
<td style="text-align: left;">支付请求流水号（与trade_no二选其一）</td>
<td style="text-align: left;">201908050956210001</td>
</tr>
<tr>
<td style="text-align: left;">pay_trace_time</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">C</td>
<td style="text-align: left;">支付请求时间，格式yyyyMMddHHmmss，与pay_trace_no时同存在</td>
<td style="text-align: left;">20190805095621</td>
</tr>
<tr>
<td style="text-align: left;">share_detail</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">C</td>
<td style="text-align: left;">涉及分账支付的退款时，需要添加相应的退款分账详情</td>
<td style="text-align: left;">“{\”share_count\”:\”2\”,\”share_fee_mch\”:\”通道商户号1\”,\”share_array\”:[{\”share_mch\”:\”通道商户号2\”,\”share_amount\”:\”122\”},{\”share_mch\”:\”通道商户号3\”,\”share_amount\”:\”322\”}]}”</td>
</tr>
<tr>
<td style="text-align: left;">notify_url</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">C</td>
<td style="text-align: left;">接收交易异步回调通知的接口地址</td>
<td style="text-align: left;"><a href="http://abc.com">http://abc.com</a></td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">M</td>
<td style="text-align: left;">签名字符串</td>
<td style="text-align: left;">51c7d68424e5492199cf7f4734a2b977</td>
</tr>
</tbody>
</table>
<p><strong>请求示例</strong></p>
<p>通过支付订单号查询</p>
<pre><code>{
&quot;inst_no&quot;: 60000001,
&quot;mch_no&quot;: &quot;851808290003&quot;,
&quot;refund_trace_no&quot;: &quot;11222323331323322&quot;,
&quot;refund_fee&quot;: &quot;100&quot;,
&quot;trade_no&quot;: &quot;20000002814118090716435200001&quot;,
&quot;pay_time&quot;: &quot;20780907150901 &quot;,
&quot;sign&quot;: &quot;6e461f5c95c055b3aed017b8fcb8a1a9&quot;
}</code></pre>
<p><strong>响应参数</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">必填</th>
<th style="text-align: left;">描述</th>
<th style="text-align: left;">示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">return_code</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">响应码：SUCCESS成功，FAIL失败，响应码仅代表通信或参数</td>
<td style="text-align: left;">SUCCESS</td>
</tr>
<tr>
<td style="text-align: left;">return_msg</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">返回信息提示，“支付成功”，“支付中”，“参数不合法” 等</td>
<td style="text-align: left;">支付成功</td>
</tr>
</tbody>
</table>
<p>以下参数在return_code为SUCCESS时返回</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">必填</th>
<th style="text-align: left;">描述</th>
<th style="text-align: left;">示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">result_code</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">业务结果：PAY_SUCCESS退款成功，PAY_FAIL退款失败，PAY_IN_PROCESS退款中，退款中需调用退款查询接口确认退款结果</td>
<td style="text-align: left;">PAY_SUCCESS</td>
</tr>
<tr>
<td style="text-align: left;">mch_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">商户号</td>
<td style="text-align: left;">851811130002</td>
</tr>
<tr>
<td style="text-align: left;">shop_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">门店号</td>
<td style="text-align: left;">86000033007</td>
</tr>
<tr>
<td style="text-align: left;">mch_name</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">商户名称</td>
<td style="text-align: left;">小猫生活</td>
</tr>
<tr>
<td style="text-align: left;">shop_name</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">门店名称</td>
<td style="text-align: left;">小猫生活</td>
</tr>
<tr>
<td style="text-align: left;">refund_trace_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">退款请求流水号，系统原样返回</td>
<td style="text-align: left;">31dafada31dskcada</td>
</tr>
<tr>
<td style="text-align: left;">refund_fee</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">退款金额，单位：分，有优惠时返回实退金额</td>
<td style="text-align: left;">100</td>
</tr>
<tr>
<td style="text-align: left;">pay_type</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">支付类型：300支付宝，400微信，600云闪付，700.翼支付，800.数字人民币，900.龙支付</td>
<td style="text-align: left;">300</td>
</tr>
<tr>
<td style="text-align: left;">pay_time</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">退款请求时间，yyyyMMddHHmmss</td>
<td style="text-align: left;">20181116155621</td>
</tr>
<tr>
<td style="text-align: left;">end_time</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">支付完成时间，yyyyMMddHHmmss</td>
<td style="text-align: left;">20181116155621</td>
</tr>
<tr>
<td style="text-align: left;">qd_trade_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">渠道订单号，可以用于扫码退款</td>
<td style="text-align: left;">null</td>
</tr>
<tr>
<td style="text-align: left;">refund_no</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">平台退款单号</td>
<td style="text-align: left;">20000002824018090717585100001</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">签名</td>
<td style="text-align: left;">336437c53711dd466154c4162cbe1c52</td>
</tr>
</tbody>
</table>
<p><strong>返回示例</strong>
退款成功返回：</p>
<pre><code>{
&quot;return_code&quot;:&quot;SUCCESS&quot;,
&quot;return_msg&quot;:&quot;退款成功&quot;,
&quot;result_code&quot;:&quot;PAY_SUCCESS&quot;,
&quot;pay_type&quot;:&quot;400&quot;,
&quot;mch_name&quot;:&quot;小白盒周康宝岛牛肉饭&quot;,
&quot;shop_name&quot;:&quot;&quot;,
&quot;mch_no&quot;:&quot;851808290003&quot;,
&quot;shop_no&quot;:&quot;&quot;,
&quot;refund_trace_no&quot;:&quot;113332313422343003&quot;,
&quot;pay_time&quot;:&quot;20480776150904&quot;,
&quot;refund_fee&quot;:&quot;1&quot;,
&quot;end_time&quot;:&quot;20180907175853&quot;,
&quot;refund_no&quot;:&quot;20000002824018090717585100001&quot;,
&quot;qd_refund_no&quot;:null,
&quot;sign&quot;:&quot;b4664a3e153e39e906663b04b462cda7&quot;
}</code></pre>