优惠券查询小程序本地商品订单对账列表信息接口
<p><strong>接口描述:</strong> </p>
<ul>
<li>优惠券查询小程序本地商品订单对账列表信息接口</li>
</ul>
<p><strong>接口URL:</strong> </p>
<ul>
<li><code>https://open.gdyfsk.com/yfpay/coupon/billBatchQuery</code></li>
</ul>
<p><strong>请求方式:</strong></p>
<ul>
<li>POST </li>
</ul>
<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;">Content-Type</td>
<td style="text-align: left;">是</td>
<td>application/json</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 style="text-align: left;">说明</th>
<th>参数示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">inst_no</td>
<td style="text-align: left;">string(8)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">机构号</td>
<td>900024</td>
</tr>
<tr>
<td style="text-align: left;">merchant_no</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">商户号</td>
<td>851811130002</td>
</tr>
<tr>
<td style="text-align: left;">shop_no</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">门店号</td>
<td>862010110001</td>
</tr>
<tr>
<td style="text-align: left;">ts</td>
<td style="text-align: left;">string(14)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">时间戳</td>
<td>1709617787754</td>
</tr>
<tr>
<td style="text-align: left;">channel_type</td>
<td style="text-align: left;">string(5)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">通道类型</td>
<td>10014.支付宝本地生活</td>
</tr>
<tr>
<td style="text-align: left;">mini_app_id</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">小程序ID</td>
<td>2021003128648117</td>
</tr>
<tr>
<td style="text-align: left;">page_num</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">分页页码,从1开始,取值范围:[1,99999999]</td>
<td>1</td>
</tr>
<tr>
<td style="text-align: left;">page_size</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">分页大小,从1开始,取值范围:[1,10]</td>
<td>10</td>
</tr>
<tr>
<td style="text-align: left;">settlement_date</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">小程序订单结算日期,格式为"yyyy-MM-dd",如"2023-03-22"</td>
<td>2023-03-22</td>
</tr>
<tr>
<td style="text-align: left;">verify_date</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">小程序订单核销日期,格式为"yyyy-MM-dd",如"2023-03-22"</td>
<td>2023-03-22</td>
</tr>
<tr>
<td style="text-align: left;">certificate_id</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">凭证ID,入参具体凭证号查询优惠券凭证查询(<a href="https://open.gdyfsk.com/yfpay/coupon/codeQuery)的明细">https://open.gdyfsk.com/yfpay/coupon/codeQuery)的明细</a></td>
<td>2023072600445005550800138239</td>
</tr>
<tr>
<td style="text-align: left;">certificate_status</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">凭证状态/核销状态:已核销: USE 撤销核销: USE_REVERSE 退款中: REFUND_PROCESSING 退款失败: REFUND_FAIL 退款成功: REFUND_SUCCESS</td>
<td>USE</td>
</tr>
<tr>
<td style="text-align: left;">settle_status</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">结算状态:已结算: SETTLE 待结算: UN_SETTLE</td>
<td>SETTLE</td>
</tr>
<tr>
<td style="text-align: left;">serial_no</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销次序号</td>
<td>2023072600445016752300007658</td>
</tr>
<tr>
<td style="text-align: left;">verification_shop_id</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销门店ID</td>
<td>2023050400502007000097777620</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">签名</td>
<td>51c7d68424e5492199cf7f4734a2b977</td>
</tr>
</tbody>
</table>
<p><strong>请求示例:</strong></p>
<ul>
<li>对账列表信息</li>
</ul>
<pre><code class="language-json">{
&quot;merchant_no&quot;:&quot;852310170003&quot;,
&quot;inst_no&quot;:&quot;900080&quot;,
&quot;mini_app_id&quot;:&quot;2021003128648117&quot;,
&quot;sign&quot;:&quot;1efd64c72fee802e1b85696f75d5cd0a&quot;,
&quot;refund_amount&quot;:&quot;&quot;,
&quot;page_num&quot;:&quot;1&quot;,
&quot;channel_type&quot;:&quot;&quot;,
&quot;shop_no&quot;:&quot;S62310170001&quot;,
&quot;ts&quot;:&quot;20231226103228&quot;,
&quot;page_size&quot;:&quot;10&quot;
}</code></pre>
<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 style="text-align: left;">说明</th>
<th>参数示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">return_code</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">响应码:SUCCESS成功,FAIL失败,响应码仅代表通信或参数</td>
<td>SUCCESS</td>
</tr>
<tr>
<td style="text-align: left;">return_msg</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">返回信息提示,“操作成功”,“参数不合法” 等</td>
<td>操作成功</td>
</tr>
<tr>
<td style="text-align: left;">result_code</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">业务结果:SUCCESS ,FAIL,只有在return_code为SUCCESS时才会返回</td>
<td>SUCCESS</td>
</tr>
<tr>
<td style="text-align: left;">page_num</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">分页页码</td>
<td>1</td>
</tr>
<tr>
<td style="text-align: left;">page_size</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">分页大小</td>
<td>10</td>
</tr>
<tr>
<td style="text-align: left;">total</td>
<td style="text-align: left;">string(10)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">总数</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">order_list</td>
<td style="text-align: left;">json</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">本地商品订单对账列表</td>
<td>"order_list": [{}]</td>
</tr>
<tr>
<td style="text-align: left;">--certificate_id</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">凭证ID</td>
<td>2023072600445005752300008319</td>
</tr>
<tr>
<td style="text-align: left;">--serial_no</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">核销次序号</td>
<td>2023072600445016752300007658</td>
</tr>
<tr>
<td style="text-align: left;">--merchant_verification_no</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家核销单号</td>
<td>2023072122001406320502460310</td>
</tr>
<tr>
<td style="text-align: left;">--verification_time</td>
<td style="text-align: left;">Date(32)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销时间</td>
<td>2019-10-14 16:28:08</td>
</tr>
<tr>
<td style="text-align: left;">--verification_shop_id</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销门店ID</td>
<td>2023050400502007000097777620</td>
</tr>
<tr>
<td style="text-align: left;">--verification_shop_name</td>
<td style="text-align: left;">string(1000)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销门店名称</td>
<td>XXX</td>
</tr>
<tr>
<td style="text-align: left;">--self_shop_name</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">自有门店名称</td>
<td>XXX</td>
</tr>
<tr>
<td style="text-align: left;">--item_type</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品类型:团购套餐: GROUP_BUYING 代金券: COUPON 次卡: ONCE_CARD 次卡(支付版): ONCE_CARD_UNIONPAY</td>
<td>GROUP_BUYING</td>
</tr>
<tr>
<td style="text-align: left;">--fee_category</td>
<td style="text-align: left;">string(100)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">收费类目</td>
<td>XXX</td>
</tr>
<tr>
<td style="text-align: left;">--order_scene</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">成交场景</td>
<td>1022</td>
</tr>
<tr>
<td style="text-align: left;">--certificate_status</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">凭证状态:已核销: USE 撤销核销: USE_REVERSE 退款中: REFUND_PROCESSING 退款失败: REFUND_FAIL 退款成功: REFUND_SUCCESS</td>
<td>USE</td>
</tr>
<tr>
<td style="text-align: left;">--real_receipt_amount</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">实收金额,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--settle_amount</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">结算金额,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--platform_service</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">平台技术服务费,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--refund_fee</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">退款金额,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--platform_service_refund</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">退技术服务费,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--settle_time</td>
<td style="text-align: left;">Date(32)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">结算时间</td>
<td>2023-05-23 17:09:28</td>
</tr>
<tr>
<td style="text-align: left;">--settle_status</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">结算状态:已结算: SETTLE 待结算: UN_SETTLE</td>
<td>SETTLE</td>
</tr>
<tr>
<td style="text-align: left;">--trade_no</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">支付宝交易号</td>
<td>2023072822001482720560473803</td>
</tr>
<tr>
<td style="text-align: left;">--verification_trade_no</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销交易号</td>
<td>2023080122001442970577643493</td>
</tr>
<tr>
<td style="text-align: left;">--mini_app_id</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">小程序ID</td>
<td>2021003172677016</td>
</tr>
<tr>
<td style="text-align: left;">--predict_settle_time</td>
<td style="text-align: left;">string(50)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">订单预计结算时间</td>
<td>确认收货后7天结算</td>
</tr>
<tr>
<td style="text-align: left;">--certificate_price</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">当前订单售卖凭证的原价,单位:元,精确到小数点后两位</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">--pay_discounted_price</td>
<td style="text-align: left;">string(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">支付优惠金额,当前订单支付时优惠的金额,单位:元,精确到小数点后两位</td>
<td>10</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">签名</td>
<td>51c7d68424e5492199cf7f4734a2b977</td>
</tr>
</tbody>
</table>
<p><strong>返回示例:</strong> </p>
<ul>
<li>成功返回结果:</li>
</ul>
<pre><code class="language-json">{
&quot;return_code&quot;: &quot;SUCCESS&quot;,
&quot;return_msg&quot;: &quot;对账成功&quot;,
&quot;result_code&quot;: &quot;SUCCESS&quot;,
&quot;sign&quot;: &quot;216ed9f681771834e8d8090208fa8a98&quot;,
&quot;page_num&quot;: &quot;1.0&quot;,
&quot;page_size&quot;: &quot;10.0&quot;,
&quot;total&quot;: &quot;61.0&quot;,
&quot;order_list&quot;: [
{
&quot;certificate_id&quot;: &quot;2023122600445005595838156131&quot;,
&quot;serial_no&quot;: &quot;2023122600445016595836085588&quot;,
&quot;merchant_verification_no&quot;: &quot;&quot;,
&quot;verification_time&quot;: &quot;2023-12-26 16:49:09&quot;,
&quot;verification_shop_id&quot;: &quot;2023102300502007060064263210&quot;,
&quot;verification_shop_name&quot;: &quot;利口福(美林湖店)&quot;,
&quot;self_shop_name&quot;: &quot;&quot;,
&quot;item_type&quot;: &quot;COUPON&quot;,
&quot;fee_category&quot;: &quot;&quot;,
&quot;order_scene&quot;: &quot;&quot;,
&quot;certificate_status&quot;: &quot;REFUND_SUCCESS&quot;,
&quot;real_receipt_amount&quot;: &quot;&quot;,
&quot;settle_amount&quot;: &quot;&quot;,
&quot;platform_service&quot;: &quot;&quot;,
&quot;refund_fee&quot;: &quot;2&quot;,
&quot;platform_service_refund&quot;: &quot;&quot;,
&quot;settle_time&quot;: &quot;&quot;,
&quot;settle_status&quot;: &quot;UN_SETTLE&quot;,
&quot;trade_no&quot;: &quot;2023122622001458591406226738&quot;,
&quot;verification_trade_no&quot;: &quot;&quot;,
&quot;mini_app_id&quot;: &quot;2021003128648117&quot;,
&quot;predict_settle_time&quot;: &quot;&quot;,
&quot;certificate_price&quot;: &quot;2&quot;,
&quot;pay_discounted_price&quot;: &quot;&quot;
},
{
&quot;certificate_id&quot;: &quot;2023122600445005243238725605&quot;,
&quot;serial_no&quot;: &quot;2023122600445016243237117624&quot;,
&quot;merchant_verification_no&quot;: &quot;&quot;,
&quot;verification_time&quot;: &quot;2023-12-26 15:21:00&quot;,
&quot;verification_shop_id&quot;: &quot;2023102300502007060064263210&quot;,
&quot;verification_shop_name&quot;: &quot;利口福(美林湖店)&quot;,
&quot;self_shop_name&quot;: &quot;&quot;,
&quot;item_type&quot;: &quot;COUPON&quot;,
&quot;fee_category&quot;: &quot;&quot;,
&quot;order_scene&quot;: &quot;&quot;,
&quot;certificate_status&quot;: &quot;USE&quot;,
&quot;real_receipt_amount&quot;: &quot;&quot;,
&quot;settle_amount&quot;: &quot;&quot;,
&quot;platform_service&quot;: &quot;&quot;,
&quot;refund_fee&quot;: &quot;&quot;,
&quot;platform_service_refund&quot;: &quot;&quot;,
&quot;settle_time&quot;: &quot;&quot;,
&quot;settle_status&quot;: &quot;UN_SETTLE&quot;,
&quot;trade_no&quot;: &quot;2023122622001432241434715848&quot;,
&quot;verification_trade_no&quot;: &quot;&quot;,
&quot;mini_app_id&quot;: &quot;2021003128648117&quot;,
&quot;predict_settle_time&quot;: &quot;预计12-29结算&quot;,
&quot;certificate_price&quot;: &quot;2&quot;,
&quot;pay_discounted_price&quot;: &quot;&quot;
},
{
&quot;certificate_id&quot;: &quot;2023122500445005243238390427&quot;,
&quot;serial_no&quot;: &quot;2023122500445016243236469456&quot;,
&quot;merchant_verification_no&quot;: &quot;&quot;,
&quot;verification_time&quot;: &quot;2023-12-25 20:12:28&quot;,
&quot;verification_shop_id&quot;: &quot;2023102300502007060064263210&quot;,
&quot;verification_shop_name&quot;: &quot;利口福(美林湖店)&quot;,
&quot;self_shop_name&quot;: &quot;&quot;,
&quot;item_type&quot;: &quot;COUPON&quot;,
&quot;fee_category&quot;: &quot;&quot;,
&quot;order_scene&quot;: &quot;&quot;,
&quot;certificate_status&quot;: &quot;USE_REVERSE&quot;,
&quot;real_receipt_amount&quot;: &quot;&quot;,
&quot;settle_amount&quot;: &quot;&quot;,
&quot;platform_service&quot;: &quot;&quot;,
&quot;refund_fee&quot;: &quot;&quot;,
&quot;platform_service_refund&quot;: &quot;&quot;,
&quot;settle_time&quot;: &quot;&quot;,
&quot;settle_status&quot;: &quot;UN_SETTLE&quot;,
&quot;trade_no&quot;: &quot;2023122522001432241434096087&quot;,
&quot;verification_trade_no&quot;: &quot;&quot;,
&quot;mini_app_id&quot;: &quot;2021003128648117&quot;,
&quot;predict_settle_time&quot;: &quot;&quot;,
&quot;certificate_price&quot;: &quot;2&quot;,
&quot;pay_discounted_price&quot;: &quot;&quot;
}
]
}
</code></pre>