优惠券凭证查询
<p><strong>接口描述：</strong> </p>
<ul>
<li>优惠券凭证查询</li>
</ul>
<p><strong>接口URL：</strong> </p>
<ul>
<li><code>https://open.gdyfsk.com/yfpay/coupon/codeQuery</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;">coupon_code</td>
<td style="text-align: left;">string(16)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">优惠券码</td>
<td>000275357242</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;">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;coupon_code&quot;:&quot;000276599242&quot;,
&quot;inst_no&quot;:&quot;900080&quot;,
&quot;sign&quot;:&quot;bc69f02b4960159f327275ba5ab61ea3&quot;,
&quot;channel_type&quot;:&quot;&quot;,
&quot;shop_no&quot;:&quot;S62310170001&quot;,
&quot;ts&quot;:&quot;20231222170112&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;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">签名</td>
<td>778e1fb75c06d9efe2a91e7912641f3d</td>
</tr>
<tr>
<td style="text-align: left;">certificate_info_list</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">凭证信息列表，JSON格式的数组</td>
</tr>
<tr>
<td style="text-align: left;">--certificate_id</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">用户凭证id</td>
<td>2023052800445005825800000196</td>
</tr>
<tr>
<td style="text-align: left;">--code</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">三方码：支付宝平台码场景该值为空</td>
<td>123AB</td>
</tr>
<tr>
<td style="text-align: left;">--status</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">状态："UNUSE"未使用，"USED"已使用，"EXPIRED"已过期，"INVALID"已失效</td>
<td>1997081101502300000001290055702988</td>
</tr>
<tr>
<td style="text-align: left;">--valid_begin_time</td>
<td style="text-align: left;">date(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">开始生效时间</td>
<td>2023-01-01 00:00:00</td>
</tr>
<tr>
<td style="text-align: left;">--valid_end_time</td>
<td style="text-align: left;">date(20)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">过期时间</td>
<td>2023-03-31 23:59:59</td>
</tr>
<tr>
<td style="text-align: left;">--out_order_id</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家侧核销对应的交易订单id</td>
<td>2023073101</td>
</tr>
<tr>
<td style="text-align: left;">--amount_info</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">凭证金额信息：JSON格式的数组</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">----original_price</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品原价：商品标注的原价，单位为元</td>
<td>25.00</td>
</tr>
<tr>
<td style="text-align: left;">----sale_price</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品售价：商品售卖的价格，单位为元</td>
<td>20.00</td>
</tr>
<tr>
<td style="text-align: left;">----receipt_amount</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家实收金额：商品售价去除商家订单优惠后的商家实收，未计算收单费率等，单位为元</td>
<td>20.00</td>
</tr>
<tr>
<td style="text-align: left;">--sku_info</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品信息，JSON格式的数组</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">----sku_id</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">支付宝平台侧skuID</td>
<td>2023122023000857102402</td>
</tr>
<tr>
<td style="text-align: left;">----out_sku_id</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家侧skuID</td>
<td>cs123</td>
</tr>
<tr>
<td style="text-align: left;">----item_id</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">支付宝平台侧商品ID</td>
<td>2023122022000407269413</td>
</tr>
<tr>
<td style="text-align: left;">----out_item_id</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家侧商品ID</td>
<td>cs123</td>
</tr>
<tr>
<td style="text-align: left;">----title</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品名称</td>
<td>【利口福】20代25元代金券</td>
</tr>
<tr>
<td style="text-align: left;">----item_type</td>
<td style="text-align: left;">string(2)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品模版类型：1. 团购套餐、2. 代金券</td>
<td>2</td>
</tr>
<tr>
<td style="text-align: left;">--use_rule_info</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">核销规则，JSON格式的数组</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">----use_num_limit</td>
<td style="text-align: left;">string(128)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">使用张数限制</td>
<td>{"limit":"1","num":"3"}</td>
</tr>
<tr>
<td style="text-align: left;">----use_limit</td>
<td style="text-align: left;">string(4096)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">时间限制</td>
<td>{"use_time_type":"2","use_date_list":[{"days_of_week":["1","7"],"start_time":"HH:mm:ss","end_time":"HH:mm:ss","end_time_type":"SAME_DAY"}],"can_no_use_date_list":[{"holidays":[{"start_time":"HH:mm:ss","end_time":"HH:mm:ss","end_time_type":"SAME_DAY"}]}]}</td>
</tr>
<tr>
<td style="text-align: left;">----serial_info_list</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">次卡次序号信息，JSON格式的数组</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">------serial_no</td>
<td style="text-align: left;">string(32)</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">次序号</td>
<td>2023122200445016243234414188</td>
</tr>
<tr>
<td style="text-align: left;">------status</td>
<td style="text-align: left;">string(2)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">状态</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">------amount_info</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">次序号的金额信息，JSON格式的数组</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">--------original_price</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品原价</td>
<td>25.00</td>
</tr>
<tr>
<td style="text-align: left;">--------sale_price</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商品售价</td>
<td>20.00</td>
</tr>
<tr>
<td style="text-align: left;">--------receipt_amount</td>
<td style="text-align: left;">price(11)</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">商家实收金额</td>
<td>20.00</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;c9c186f72959725394fd57e4f7281aa4&quot;,
&quot;certificateInfoList&quot;: [
{
&quot;amountInfo&quot;: {
&quot;originalPrice&quot;: &quot;4.00&quot;,
&quot;receiptAmount&quot;: &quot;2.00&quot;,
&quot;salePrice&quot;: &quot;2.00&quot;
},
&quot;canUse&quot;: null,
&quot;certificateId&quot;: &quot;2023122300445005243236776565&quot;,
&quot;code&quot;: null,
&quot;outOrderId&quot;: null,
&quot;skuInfo&quot;: {
&quot;itemId&quot;: &quot;2023122322000207389941&quot;,
&quot;itemType&quot;: &quot;2&quot;,
&quot;outItemId&quot;: &quot;cs100&quot;,
&quot;outSkuId&quot;: &quot;cs100&quot;,
&quot;skuId&quot;: &quot;2023122323000058138302&quot;,
&quot;title&quot;: &quot;【利口福】2元代金券&quot;
},
&quot;status&quot;: &quot;UNUSE&quot;,
&quot;timesCardInfo&quot;: {
&quot;serialInfoList&quot;: [
{
&quot;amountInfo&quot;: {
&quot;originalPrice&quot;: &quot;4.00&quot;,
&quot;receiptAmount&quot;: &quot;2.00&quot;,
&quot;salePrice&quot;: &quot;2.00&quot;
},
&quot;serialNo&quot;: &quot;2023122300445016243235056637&quot;,
&quot;status&quot;: &quot;UNUSE&quot;
}
],
&quot;totalCount&quot;: 1,
&quot;usedCount&quot;: 0
},
&quot;useRuleInfo&quot;: {
&quot;useLimit&quot;: &quot;{\&quot;use_time_type\&quot;:\&quot;1\&quot;}&quot;,
&quot;useNumLimit&quot;: null
},
&quot;validBeginTime&quot;: 1703315423000,
&quot;validEndTime&quot;: 1703488223000
}
]
}
</code></pre>