乐檬统一接口

乐檬统一接口


订单退款

<h1>订单退款接口文档</h1> <h2>一、接口使用前提</h2> <p>需先在商户后台开启订单退款 API 接口开关,方可调用此接口发起订单退款操作。</p> <h2>二、接口基本信息</h2> <ol> <li><strong>请求地址</strong>:<code>https://pay.lmwa.cn/api/pay/refund</code></li> <li><strong>请求方式</strong>:POST</li> </ol> <h2>三、请求参数</h2> <table> <thead> <tr> <th>字段名</th> <th>变量名</th> <th>必填</th> <th>类型</th> <th>示例值</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>商户 ID</td> <td>pid</td> <td>是</td> <td>Int</td> <td>1001</td> <td>商户在平台的唯一标识</td> </tr> <tr> <td>平台订单号</td> <td>trade_no</td> <td>特殊</td> <td>String</td> <td>20160806151343349</td> <td>与商户订单号二者必传其一,用于定位订单</td> </tr> <tr> <td>商户订单号</td> <td>out_trade_no</td> <td>特殊</td> <td>String</td> <td>20160806151343351</td> <td>与平台订单号二者必传其一,用于定位订单</td> </tr> <tr> <td>退款金额</td> <td>money</td> <td>是</td> <td>String</td> <td>1.00</td> <td>单位为元,明确退款的具体金额</td> </tr> <tr> <td>商户退款单号</td> <td>out_refund_no</td> <td>否</td> <td>String</td> <td>20160806151343391</td> <td>可避免重复发起退款请求,若不传,平台可能按默认规则处理</td> </tr> <tr> <td>当前时间戳</td> <td>timestamp</td> <td>是</td> <td>String</td> <td>1721206072</td> <td>10 位整数,单位为秒,用于校验请求时效性</td> </tr> <tr> <td>签名字符串</td> <td>sign</td> <td>是</td> <td>String</td> <td>-</td> <td>依据签名规则生成,用于验证请求合法性</td> </tr> <tr> <td>签名类型</td> <td>sign_type</td> <td>是</td> <td>String</td> <td>RSA</td> <td>默认采用 RSA 签名算法</td> </tr> </tbody> </table> <h2>四、返回参数</h2> <table> <thead> <tr> <th>字段名</th> <th>变量名</th> <th>类型</th> <th>示例值</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>返回状态码</td> <td>code</td> <td>Int</td> <td>0</td> <td>0 表示退款请求成功,其他值代表失败</td> </tr> <tr> <td>返回信息</td> <td>msg</td> <td>String</td> <td>-</td> <td>退款操作成功或失败时的提示信息</td> </tr> <tr> <td>平台退款单号</td> <td>refund_no</td> <td>String</td> <td>20160806151343349</td> <td>平台生成的退款订单编号</td> </tr> <tr> <td>商户退款单号</td> <td>out_refund_no</td> <td>String</td> <td>20160806151343351</td> <td>商户自定义的退款单号(若有)</td> </tr> <tr> <td>平台订单号</td> <td>trade_no</td> <td>String</td> <td>20160806151343349</td> <td>原订单对应的平台订单号</td> </tr> <tr> <td>退款金额</td> <td>money</td> <td>String</td> <td>-</td> <td>实际退款的金额</td> </tr> <tr> <td>扣减商户余额</td> <td>reducemoney</td> <td>String</td> <td>-</td> <td>从商户账户扣除的退款金额(可能因手续费等因素与退款金额有差异)</td> </tr> <tr> <td>当前时间戳</td> <td>timestamp</td> <td>String</td> <td>1721206072</td> <td>10 位整数,单位为秒,与请求中的时间戳对应</td> </tr> <tr> <td>签名字符串</td> <td>sign</td> <td>String</td> <td>-</td> <td>用于验证返回数据的合法性,参考签名规则</td> </tr> <tr> <td>签名类型</td> <td>sign_type</td> <td>String</td> <td>RSA</td> <td>默认采用 RSA 签名算法</td> </tr> </tbody> </table> <h2>五、其他说明</h2> <p>部分通过插件对接的第三方平台不支持部分金额退款。在发起退款请求时,若涉及此类平台,需注意全额退款的限制,避免因不支持部分退款导致退款失败。</p>

页面列表

ITEM_HTML