聚合支付接口文档

聚合支付接口文档


【统一】订单退款

<h2>订单退款</h2> <p>&gt; /api/order/refund</p> <h3>主体请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>必填</th> <th>中文名</th> </tr> </thead> <tbody> <tr> <td>sign</td> <td>String</td> <td>✅</td> <td>签名</td> </tr> <tr> <td>timestamp</td> <td>String</td> <td>✅</td> <td>签名时间戳(毫秒)</td> </tr> <tr> <td>merchantNo</td> <td>String</td> <td>✅</td> <td>商户编号</td> </tr> <tr> <td>orderNo</td> <td>String</td> <td>❌</td> <td>商户订单号&lt;br/&gt;(orderNo和merchantOrderNo 二选一)</td> </tr> <tr> <td>merchantOrderNo</td> <td>String</td> <td>❌</td> <td>商户订单号&lt;br/&gt;(orderNo和merchantOrderNo 二选一)</td> </tr> <tr> <td>refundAmount</td> <td>int</td> <td>✅</td> <td>退款金额(分)</td> </tr> <tr> <td>notifyUrl</td> <td>String</td> <td>❌</td> <td>回调地址</td> </tr> <tr> <td>attach</td> <td>String</td> <td>❌</td> <td>附加数据,支付成功原样返回</td> </tr> </tbody> </table> <p>&gt; 请求参数示例(参数需要加密,以下是加密前的示例)</p> <pre><code class="language-json">{ &amp;quot;sign&amp;quot;: &amp;quot;291C70CA1DC3823C79ABA4DAD95C5D98&amp;quot;, &amp;quot;timestamp&amp;quot;: &amp;quot;1735660800000&amp;quot;, &amp;quot;merchantNo&amp;quot;: 17170000000000000000, &amp;quot;orderNo&amp;quot;: &amp;quot;PY000000001&amp;quot;, &amp;quot;merchantOrderNo&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;refundAmount&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;attach&amp;quot;: &amp;quot;附加信息&amp;quot;, &amp;quot;notifyUrl&amp;quot;: &amp;quot;https://1/2/3&amp;quot; }</code></pre> <h3>返回数据结构</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>必填</th> <th>是否加密</th> <th>中文名</th> </tr> </thead> <tbody> <tr> <td>success</td> <td>boolean</td> <td>是</td> <td>❌</td> <td>响应状态</td> </tr> <tr> <td>code</td> <td>integer</td> <td>是</td> <td>❌</td> <td>响应编码</td> </tr> <tr> <td>msg</td> <td>string</td> <td>是</td> <td>❌</td> <td>响应信息</td> </tr> <tr> <td>data</td> <td>object</td> <td>是</td> <td>❌</td> <td>响应数据</td> </tr> <tr> <td>↳ sign</td> <td>string</td> <td>是</td> <td>❌</td> <td>签名</td> </tr> <tr> <td>↳ timestamp</td> <td>string</td> <td>是</td> <td>❌</td> <td>签名时间戳(毫秒)</td> </tr> <tr> <td>↳ merchantNo</td> <td>string</td> <td>是</td> <td>❌</td> <td>商户编号</td> </tr> <tr> <td>↳ orderNo</td> <td>string</td> <td>是</td> <td>✅</td> <td>聚合平台交易订单号</td> </tr> <tr> <td>↳ merchantOrderNo</td> <td>string</td> <td>是</td> <td>✅</td> <td>商户交易订单号</td> </tr> <tr> <td>↳ refundNo</td> <td>string</td> <td>是</td> <td>✅</td> <td>聚合平台退款订单号</td> </tr> <tr> <td>↳ merchantRefundNo</td> <td>string</td> <td>是</td> <td>✅</td> <td>商户退款订单号</td> </tr> <tr> <td>↳ refundAmount</td> <td>string</td> <td>是</td> <td>✅</td> <td>退款金额</td> </tr> <tr> <td>↳ refundState</td> <td>string</td> <td>是</td> <td>✅</td> <td>订单退款状态 1:退款中 2:退款成功 3:退款失败</td> </tr> <tr> <td>↳ attach</td> <td>string</td> <td>是</td> <td>✅</td> <td>附加数据</td> </tr> <tr> <td>↳ appliedTime</td> <td>string</td> <td>是</td> <td>✅</td> <td>发起退款时间</td> </tr> </tbody> </table> <p>&gt; 返回示例(data参数需要解密,以下是实际响应数据示例)</p> <p>状态码 <strong>200</strong></p> <pre><code class="language-json">{ &amp;quot;success&amp;quot;: true, &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;操作成功&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;sign&amp;quot;: &amp;quot;291C70CA1DC3823C79ABA4DAD95C5D98&amp;quot;, &amp;quot;timestamp&amp;quot;: 1743582863829, &amp;quot;merchantNo&amp;quot;: &amp;quot;17170000000000000000&amp;quot;, &amp;quot;orderNo&amp;quot;: &amp;quot;t3q96ediYXvvWbi1eqHJ5YBthAoEyWqIzkOqAWiai/E=&amp;quot;, &amp;quot;merchantOrderNo&amp;quot;: &amp;quot;WLXzddn2ATFBPSf9kI4edk9VltyAJ8/TTiSb7V1TT80=&amp;quot;, &amp;quot;refundNo&amp;quot;: &amp;quot;t3q96ediYXvvWbi1eqHJ5YBthAoEyWqIzkOqAWiai/E=&amp;quot;, &amp;quot;merchantRefundNo&amp;quot;: &amp;quot;WLXzddn2ATFBPSf9kI4edk9VltyAJ8/TTiSb7V1TT80=&amp;quot;, &amp;quot;refundAmount&amp;quot;: &amp;quot;XDzklufxmMBnd7G/uISZ3w==&amp;quot;, &amp;quot;refundState&amp;quot;: &amp;quot;XDzklufxmMBnd7G/uISZ3w==&amp;quot;, &amp;quot;attach&amp;quot;: &amp;quot;hQtMf0FCe37ZPOHU4HL4xA==&amp;quot;, &amp;quot;appliedTime&amp;quot;: &amp;quot;Br/deow2oXKRDZ2B7fIE3w==&amp;quot; } }</code></pre>

页面列表

ITEM_HTML