通企付-账户

通企付账户版接口文档


统一退款

<p><strong>请求URL:</strong></p> <ul> <li><code>/refund/refundOrder</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST</li> </ul> <p><strong>请求类型:</strong></p> <ul> <li>application /json</li> </ul> <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>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mchNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>商户号</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(24)</td> <td>应用ID</td> </tr> <tr> <td style="text-align: left;">reqTime</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(13)</td> <td>请求时间,13位时间戳</td> </tr> <tr> <td style="text-align: left;">version</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(3)</td> <td>接口版本,固定:1.0</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td>签名</td> </tr> <tr> <td style="text-align: left;">signType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td>签名类型,MD5/RSA/SM2</td> </tr> <tr> <td style="text-align: left;">payOrderId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>支付订单号,与mchOrderNo二者传一即可</td> </tr> <tr> <td style="text-align: left;">mchOrderNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>商户订单号,与payOrderId二者传一即可</td> </tr> <tr> <td style="text-align: left;">mchRefundNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>商户退款单号</td> </tr> <tr> <td style="text-align: left;">refundAmount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>退款金额,单位分</td> </tr> <tr> <td style="text-align: left;">currency</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(3)</td> <td>货币代码,人民币:cny</td> </tr> <tr> <td style="text-align: left;">refundReason</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(64)</td> <td>退款原因</td> </tr> <tr> <td style="text-align: left;">clientIp</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(32)</td> <td>客户端IP,IPV4地址</td> </tr> <tr> <td style="text-align: left;">notifyUrl</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(128)</td> <td>支付结果异步回调URL,只有传了该值才会发起回调</td> </tr> <tr> <td style="text-align: left;">channelExtra</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(256)</td> <td>特定渠道发起的额外参数&lt;br&gt; 1、部分或分账退款必填,详见退款列表说明&lt;br&gt; 2、needTransfer: 1-需要资金划拨;0-不需要资金划拨。非必填,默认0</td> </tr> <tr> <td style="text-align: left;">extParam</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(512)</td> <td>商户扩展参数,回调时会原样返回</td> </tr> </tbody> </table> <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>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(128)</td> <td>返回信息:具体错误原因,例如:签名失败、参数格式校验错误</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(32)</td> <td>签名信息:对data内数据签名,如data为空则不返回</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Json</td> <td>返回数据:json格式数据</td> </tr> </tbody> </table> <p><strong>data数据格式</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">refundOrderId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>退款订单号</td> </tr> <tr> <td style="text-align: left;">mchRefundNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>商户退款单号</td> </tr> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>退款状态&lt;br&gt; 0-订单生成&lt;br&gt; 1-退款中&lt;br&gt; 2-退款成功&lt;br&gt; 3-退款失败&lt;br&gt; 4-退款关闭</td> </tr> <tr> <td style="text-align: left;">channelOrderNo</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>渠道退款单号</td> </tr> <tr> <td style="text-align: left;">errCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>渠道错误码</td> </tr> <tr> <td style="text-align: left;">errMsg</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>渠道错误描述</td> </tr> </tbody> </table> <p><strong>退款列表说明:</strong></p> <p>refundList:JSONArray格式</p> <p>1、无分账退款</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">accountType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(1)</td> <td>账户类别&lt;br&gt; 1-中间账户集&lt;br&gt; 2-托管账户集&lt;br&gt;不传默认托管账户集</td> </tr> <tr> <td style="text-align: left;">bizUserId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>退款用户ID</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td>退款金额,单位分</td> </tr> </tbody> </table> <p>2、有分账退款</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">assureOrderId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>确认支付支付订单号</td> </tr> <tr> <td style="text-align: left;">bizUserId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>退款用户ID</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td>退款金额,单位分</td> </tr> <tr> <td style="text-align: left;">splitRefundList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">JSONArray</td> <td>分账退款列表</td> </tr> <tr> <td style="text-align: left;">totalSplitAmount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td>分账退款总金额,单位分</td> </tr> </tbody> </table> <p>2.1、分账退款列表</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">bizUserId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(30)</td> <td>退款用户ID</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td>退款金额,单位分</td> </tr> </tbody> </table>

页面列表

ITEM_HTML