乐檬统一接口

乐檬统一接口


查询订单列表

<h1>查询订单列表接口开发文档</h1> <h2>一、接口概述</h2> <p>该接口主要用于商户进行订单列表查询,适用于对账操作或同步订单状态等业务场景,方便商户获取和管理订单信息。</p> <h2>二、接口基本信息</h2> <ol> <li><strong>请求地址</strong>:<code>https://pay.lmwa.cn/api/merchant/orders</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>offset</td> <td>是</td> <td>Int</td> <td>0</td> <td>表示查询的起始位置,从 0 开始计数,用于分页查询。例如,offset 为 0 表示从第一条数据开始查询,offset 为 50 表示从第 51 条数据开始查询</td> </tr> <tr> <td>每页条数</td> <td>limit</td> <td>是</td> <td>Int</td> <td>50</td> <td>指定每页返回的订单数量,最大值不能超过 50。该参数与 offset 配合使用,实现分页功能</td> </tr> <tr> <td>过滤订单状态</td> <td>status</td> <td>否</td> <td>Int</td> <td>1</td> <td>用于筛选订单状态,0 代表未支付,1 代表已支付。若不填写该参数,则返回所有状态的订单</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>data</td> <td>Array</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>

页面列表

ITEM_HTML