3、充值结果查询接口设置
<p>【本文档修改日期:2021年3月8日】</p>
<h5>简要描述</h5>
<ul>
<li>本接口的作用是查询订单的充值结果,并根据结果来处理订单</li>
<li>调用本接口的前提,是充值接口的充值结果处理选择了【调用成功时后台暂不发货,待查询接口成功后发货】。</li>
<li>下面是接口设置截图,后面逐项说明。
<img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/a493e00c0f48ffef3bb327a3ffbdd7de" alt="" /></li>
</ul>
<h5>订单查询网址(URL)</h5>
<ul>
<li>这里填写平台订单结果查询接口的网址(或说URL)。</li>
<li>这里的地址可支持{订单编号}变量
填写示例: <code>http://gateway.xxxx.com/api/getStatus</code></li>
</ul>
<h5>查询提交内容(Request Body)</h5>
<ul>
<li>这里设置的提交参数,可支持右侧变量。</li>
<li>可以使用常规的URL网址格式,如下:
<pre><code>appkey=【平台appkey】&timestamp={时间戳A}&orderId={三方订单号}&sign={md5校验}</code></pre></li>
</ul>
<h5>协议头(Request Head)</h5>
<ul>
<li>这里填写充值平台需要的协议头(大部分充值平台不需要,保持为空就可以),协议头格式为一行一条,如下示例:
<pre><code>Content-Type: application/json;charset=UTF-8</code></pre></li>
</ul>
<h5>签名校验项目</h5>
<ul>
<li>这里填写签名校验的原始文本,是{md5校验}、{md5校验UTF8}、{sha1校验}等变量的数据来源。也就是说,签名校验项目内容进行md5后,就是变量{md5校验},这个变量可以用到提交内容(Request Body)里面。如果充值平台的md5要求大写,则把本项目上方的【校验项目结果到大写】对勾勾选,不勾选则为小写。
校验项目填写示例如下:
填写示例: <code>【系统商户号】{订单编号}【key】</code></li>
</ul>
<h5>可用变量说明</h5>
<ul>
<li>下面是查询接口支持的变量说明: </li>
</ul>
<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;">{订单编号}</td>
<td style="text-align: left;">210113-449122305100358</td>
<td>拼多多的订单编号</td>
</tr>
<tr>
<td style="text-align: left;">{订单编号A}</td>
<td style="text-align: left;">210113449122305100358</td>
<td>纯数字的订单编号(个别网站订单编号不允许有字符,则可使用本变量)密码</td>
</tr>
<tr>
<td style="text-align: left;">{三方订单号}</td>
<td style="text-align: left;">12345678952</td>
<td>提交充值时返回的充值平台的订单编号</td>
</tr>
<tr>
<td style="text-align: left;">{充值号码}</td>
<td style="text-align: left;">1357777XXXX</td>
<td>拼多多订单的充值号码</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳}</td>
<td style="text-align: left;">1614778835153</td>
<td>13位到毫秒的时间戳</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳10位}</td>
<td style="text-align: left;">1614778835</td>
<td>10位到秒的时间戳</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳A}</td>
<td style="text-align: left;">20210308152301</td>
<td>时间格式:yyyyMMddHHmmss</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳B}</td>
<td style="text-align: left;">2021-03-08 15:23:01</td>
<td>时间格式:yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td style="text-align: left;">{订单时间A}</td>
<td style="text-align: left;">202005292359</td>
<td>订单时间的格式:yyyyMMddHHmm</td>
</tr>
<tr>
<td style="text-align: left;">{md5校验}</td>
<td style="text-align: left;">e10adc3949ba59abbe56e057f20f883e</td>
<td>签名校验项目进行md5编码的值</td>
</tr>
<tr>
<td style="text-align: left;">{md5校验UTF8}</td>
<td style="text-align: left;">2537e27184fef4f1e7bd717b1ac482e7</td>
<td>签名校验项目先进行UTF8编号后再进行md5编码的值,适用于签名项目带中文的情况。</td>
</tr>
<tr>
<td style="text-align: left;">{sha1校验}</td>
<td style="text-align: left;">7c4a8d09ca3762af61e59520943dc26494f8941b</td>
<td>校验项目进行sha1编码后的值</td>
</tr>
</tbody>
</table>
<ul>
<li>另外,{卡密内容}、{发货说明}、{店铺ID}、{客户ID}等变量应用较少,不再一一说明。</li>
</ul>
<h5>查询结果处理</h5>
<ul>
<li>这里设置根据充值平台查询接口返回的信息进行相应处理选择。
以下面的返回信息举例说明这里的处理:</li>
</ul>
<pre><code>{"code":0,"message":"查询成功","data":{"resultCode":0,"resultMsg":"充值成功","orderId":"960cbae1deca4239b757e2f6557fcc80","phone":"13888888888"}}</code></pre>
<ul>
<li>
<p>1、成功关键词:这里填写充值成功的关键词,如果返回消息包含此关键词,则软件将该订单作为充值成功处理,进行拼多多后台发货。比如上面返回示例,成功关键词可以填:<code>充值成功</code>,也可以填<code>"resultCode":0</code></p>
</li>
<li>
<p>2、失败关键词:这里填写充值失败的关键词,如果返回消息包含此关键词,则软件将该订单作为充值失败处理,加入到软件的异常订单中。如果可能存在多数失败结果,不同的关键词可以用中文的“|”符号隔开,比如:<code>"resultCode":3|"resultCode":4</code></p>
</li>
<li>
<p>3、超时时间设置:以小时为单位,可填写小数。即自订单提交开始,超时这个时间设置,返回的消息中即没有成功关键词,也没有失败关键词,则作为超时处理,加入到软件的异常订单。</p>
<h5>关于测试查询</h5>
</li>
<li>如果您已经有待查询的订单,可以点【测试查询】按钮,输入相关订单数据后查询查询结果。</li>
</ul>