支付商户文档


(共用)查询收款单

<p><strong>简要描述:</strong> </p> <ul> <li>查询收款接口</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>/gateway/api/v1/payments</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li><code>GET</code></li> </ul> <p><strong>请求头:</strong></p> <ul> <li><code>Authorization: {authorization}</code></li> <li><code>Content-Type: application/x-www-form-urlencoded; charset=utf-8</code></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;">offset</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer(10)</td> <td>查询偏移量</td> </tr> <tr> <td style="text-align: left;">limit</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer(10)</td> <td>订单返回数量</td> </tr> <tr> <td style="text-align: left;">payment_id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(10)</td> <td>系统订单号</td> </tr> <tr> <td style="text-align: left;">payment_cl_id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(32)</td> <td>商户订单号</td> </tr> <tr> <td style="text-align: left;">create_time__gte</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer(10)</td> <td>创建时间起(秒)</td> </tr> <tr> <td style="text-align: left;">carete_time__lte</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer(10)</td> <td>创建时间迄(秒)</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code>{ &amp;quot;error_code&amp;quot;: &amp;quot;0000&amp;quot;, &amp;quot;data&amp;quot;: [ { &amp;quot;amount&amp;quot;: 30000, &amp;quot;real_amount&amp;quot;: 0, &amp;quot;fee&amp;quot;: 0, &amp;quot;payment_id&amp;quot;: &amp;quot;PM00000145&amp;quot;, &amp;quot;payment_cl_id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;platform_id&amp;quot;: &amp;quot;PF0060&amp;quot;, &amp;quot;platform_channel_id&amp;quot;: &amp;quot;PFC00000142&amp;quot;, &amp;quot;status&amp;quot;: 3, &amp;quot;memo&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;create_time&amp;quot;: 1596425140, &amp;quot;update_time&amp;quot;: 1596425770, &amp;quot;sign&amp;quot;: &amp;quot;459408960e8e7173f6eae20c2bb8339f&amp;quot; }, { &amp;quot;amount&amp;quot;: 30000, &amp;quot;real_amount&amp;quot;: 0, &amp;quot;fee&amp;quot;: 0, &amp;quot;payment_id&amp;quot;: &amp;quot;PM00000144&amp;quot;, &amp;quot;payment_cl_id&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;platform_id&amp;quot;: &amp;quot;PF0060&amp;quot;, &amp;quot;platform_channel_id&amp;quot;: &amp;quot;PFC00000142&amp;quot;, &amp;quot;status&amp;quot;: 3, &amp;quot;memo&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;create_time&amp;quot;: 1596424960, &amp;quot;update_time&amp;quot;: 1596425590, &amp;quot;sign&amp;quot;: &amp;quot;151ed70de39dc222f3444bc84947975a&amp;quot; }, { &amp;quot;amount&amp;quot;: 50000, &amp;quot;real_amount&amp;quot;: 0, &amp;quot;fee&amp;quot;: 0, &amp;quot;payment_id&amp;quot;: &amp;quot;PM00000143&amp;quot;, &amp;quot;payment_cl_id&amp;quot;: &amp;quot;xinxin_1596380261_12&amp;quot;, &amp;quot;platform_id&amp;quot;: &amp;quot;PF0060&amp;quot;, &amp;quot;platform_channel_id&amp;quot;: &amp;quot;PFC00000257&amp;quot;, &amp;quot;status&amp;quot;: 3, &amp;quot;memo&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;create_time&amp;quot;: 1596380261, &amp;quot;update_time&amp;quot;: 1596437653, &amp;quot;sign&amp;quot;: &amp;quot;cb6eea39620bad67c6f3cbafbec6f4b7&amp;quot; } ], &amp;quot;total&amp;quot;: 3 }</code></pre> <p><strong>错误返回示例</strong></p> <pre><code> { &amp;quot;error_code&amp;quot;: &amp;quot;0006&amp;quot;, &amp;quot;error_msg&amp;quot;: &amp;quot;无效的Authorization!&amp;quot; }</code></pre> <p><strong>返回参数说明</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">error_code</td> <td style="text-align: left;">String</td> <td>错误码</td> </tr> <tr> <td style="text-align: left;">error_msg</td> <td style="text-align: left;">String</td> <td>错误讯息(如果error_code不为&quot;0000&quot;便返回)</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">Integer</td> <td>订单状态(0:待处理, 1:执行中, 2:成功, 3:取消, 4:失败)</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>所有查询条件以key=value形式以&amp;串接成QueryString带在网址后,顺序不拘(ex: <a href="https://{domain}/gateway/api/v1/payments?offset=0&amp;limit=25&amp;payment_cl_id=xxxxxx">https://{domain}/gateway/api/v1/payments?offset=0&amp;limit=25&amp;payment_cl_id=xxxxxx</a>)</li> <li>authorization为系统分配给平台之授权识别,如尚未取得请联系系统人员</li> <li>返回的每笔订单皆有签名(sign), 所有栏位皆参与签名, 参考[签名规则](<a href="https://www.showdoc.cc/diamondpay?page_id=2571966527973026">https://www.showdoc.cc/diamondpay?page_id=2571966527973026</a> &quot;签名规则&quot;)</li> <li>订单将由创建时间降序排序,后进先出</li> <li>查询偏移缺省值为0</li> <li>查询数量缺省值为25,最高为500</li> <li>创建时间起迄必须同时填入才有效,皆填入Unix timestamp</li> </ul>

页面列表

ITEM_HTML