招联对接文档


1.7 退款申请接口

<h2>退款申请接口</h2> <p><strong>接口地址</strong>:<code>/pay/api/1.0/refund</code></p> <p><strong>请求方式</strong>:<code>POST</code></p> <p><strong>请求数据类型</strong>:<code>application/json</code></p> <p><strong>响应数据类型</strong>:<code>application/json</code></p> <p><strong>接口描述</strong>: 当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,扫码支付平台将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家帐号上。</p> <p>总退款金额不能超过订单总金额。</p> <p><code>注:</code>目前支持对<code>180天</code>以内的交易进行退款,支持全额或者是多次部分退款。 如需支持180天内的退款,需要在请求报文中填写:dealDate(原交易日期,格式:yyyyMMdd) <strong><code>不填该值,支持30天内的交易进行退款。</code></strong> <strong><code>填写该值,支持180天</code></strong></p> <p><strong>请求示例</strong>:</p> <pre><code class="language-javascript">{ &amp;quot;appId&amp;quot;: &amp;quot;MCH_A698612520&amp;quot;, &amp;quot;amount&amp;quot;: 1, &amp;quot;dealDate&amp;quot;: &amp;quot;20230327&amp;quot;, &amp;quot;extParam&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;mchNo&amp;quot;: &amp;quot;MCH_I293975931&amp;quot;, &amp;quot;mchOrderNo&amp;quot;: &amp;quot;202303271529422244655559&amp;quot;, &amp;quot;operatorId&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;refundAmt&amp;quot;: 1, &amp;quot;refundOrderNo&amp;quot;: &amp;quot;202303271529422244655566&amp;quot;, &amp;quot;sign&amp;quot;: &amp;quot;449b0a987ae340e1eb4dd63ddda5b3a4&amp;quot;, &amp;quot;termId&amp;quot;: &amp;quot;88888888&amp;quot;, &amp;quot;wayCode&amp;quot;: &amp;quot;WECHAT&amp;quot; }</code></pre> <p><strong>请求参数</strong>:</p> <table> <thead> <tr> <th>参数名称</th> <th>参数说明</th> <th>请求类型</th> <th>是否必须</th> <th>数据类型</th> <th>schema</th> </tr> </thead> <tbody> <tr> <td>req</td> <td>req</td> <td>body</td> <td>订单退款请求实体类</td> <td>订单退款请求实体类</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;version</td> <td>版本号</td> <td>false</td> <td>string</td> <td>默认1.0</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;sign</td> <td>签名值</td> <td><code>true</code></td> <td>string</td> <td>详见签名生成算法</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;termId</td> <td>终端id</td> <td><code>true</code></td> <td>string</td> <td>没有真实终端号统一填88888888</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;mchNo</td> <td>商户号</td> <td><code>true</code></td> <td>string</td> <td>招联分配给二级商户的商户号</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;appId</td> <td>应用id</td> <td><code>true</code></td> <td>string</td> <td>商户配置的应用id</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;mchOrderNo</td> <td>商户订单号</td> <td><code>true</code></td> <td>string</td> <td>商户订单号, 商户系统内部的订单号(5到30个字符、 只能包含字母数字下划线,区分大小写)</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;wayCode</td> <td>支付方式</td> <td>false</td> <td>string</td> <td>ALIPAY(统一下单、条码支付、服务窗支付)&lt;br&gt; WECHAT(统一下单、条码支付、公众号支付、小程序)&lt;br&gt; UNIONPAY BESTPAY(翼支付)&lt;br&gt; PY68(银联分期-商户贴息)&lt;br&gt; PY69(银联分期-持卡人贴息)</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;refundOrderNo</td> <td>商户退款单号</td> <td><code>true</code></td> <td>string</td> <td>支付订单号</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;amount</td> <td>总金额</td> <td>false</td> <td>number</td> <td>单位:分</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;refundAmt</td> <td>退款金额</td> <td><code>true</code></td> <td>number</td> <td>单位:分</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;operatorId</td> <td>操作员</td> <td>false</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;fyTermId</td> <td>富友终端号</td> <td>false</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;dealDate</td> <td>原交易日期</td> <td>false</td> <td>string</td> <td>yyyyMMdd</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;extParam</td> <td>附加数据</td> <td>false</td> <td>string</td> <td>附加数据</td> </tr> </tbody> </table> <p><strong>响应状态</strong>:</p> <table> <thead> <tr> <th>状态码</th> <th>说明</th> <th>schema</th> </tr> </thead> <tbody> <tr> <td>200</td> <td>OK</td> <td>R«订单退款返回实体类»</td> </tr> </tbody> </table> <p>&gt;见[应答码表](<a href="https://www.showdoc.com.cn/jucaishangfu/9966099368299628">https://www.showdoc.com.cn/jucaishangfu/9966099368299628</a> &quot;应答码表&quot;)</p> <p><strong>响应参数</strong>:</p> <table> <thead> <tr> <th>参数名称</th> <th>参数说明</th> <th>类型</th> <th>schema</th> </tr> </thead> <tbody> <tr> <td>code</td> <td>integer(int32)</td> <td>integer(int32)</td> </tr> <tr> <td>data</td> <td>订单退款返回实体类</td> <td>订单退款返回实体类</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;dealDate</td> <td>交易日期(yyyyMMdd)</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;orgId</td> <td>机构号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;mchNo</td> <td>商户号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;mchOrderNo</td> <td>商户订单号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;randomStr</td> <td>随机字符串</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;refundAmt</td> <td>退款金额</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;refundId</td> <td>渠道退款流水号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;refundOrderNo</td> <td>商户退款单号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;termId</td> <td>终端号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;traceNo</td> <td>系统内部追踪号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;transactionId</td> <td>渠道订单号</td> <td>string</td> </tr> <tr> <td>&amp;emsp;&amp;emsp;wayCode</td> <td>支付方式</td> <td>string</td> </tr> <tr> <td>msg</td> <td>string</td> </tr> <tr> <td>sign</td> <td>string</td> </tr> </tbody> </table> <p><strong>响应示例</strong>:</p> <pre><code class="language-javascript">{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;SUCCESS&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;returnCode&amp;quot;: &amp;quot;000000&amp;quot;, &amp;quot;returnMsg&amp;quot;: &amp;quot;SUCCESS&amp;quot;, &amp;quot;termId&amp;quot;: &amp;quot;88888888&amp;quot;, &amp;quot;randomStr&amp;quot;: &amp;quot;T0TB85UYAV9NRQI9ED508P7LNG3RCCJR&amp;quot;, &amp;quot;orgId&amp;quot;: &amp;quot;ISV_I238002400&amp;quot;, &amp;quot;mchNo&amp;quot;: &amp;quot;MCH_I293975931&amp;quot;, &amp;quot;wayCode&amp;quot;: &amp;quot;WECHAT&amp;quot;, &amp;quot;mchOrderNo&amp;quot;: &amp;quot;202303271529422244655559&amp;quot;, &amp;quot;refundOrderNo&amp;quot;: &amp;quot;202303271529422244655566&amp;quot;, &amp;quot;transactionId&amp;quot;: &amp;quot;4200067681202303275321464464&amp;quot;, &amp;quot;refundId&amp;quot;: &amp;quot;50101205262023032732569102729&amp;quot;, &amp;quot;dealDate&amp;quot;: &amp;quot;20230327&amp;quot;, &amp;quot;refundAmt&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;traceNo&amp;quot;: &amp;quot;030062147383&amp;quot; }, &amp;quot;sign&amp;quot;: &amp;quot;dddf76be0a661b87c53bffb1cb9d04a0&amp;quot; }</code></pre>

页面列表

ITEM_HTML