订单查单

<h1 id="5" href="#5">响应参数</h1> <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 style="text-align:left">示例值</th> <th style="text-align:left">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align:left">order_id</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">19062837751058701652</td> <td style="text-align:left">订单编号</td> </tr> <tr> <td style="text-align:left">customer_order_no</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">201906281030191013526</td> <td style="text-align:left">外部订单号，每次请求必须唯一</td> </tr> <tr> <td style="text-align:left">product_id</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">10000001</td> <td style="text-align:left">商品Id</td> </tr> <tr> <td style="text-align:left">product_name</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">腾讯Q币直充一元</td> <td style="text-align:left">商品名称</td> </tr> <tr> <td style="text-align:left">charge_account</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left">888888</td> <td style="text-align:left">充值账号</td> </tr> <tr> <td style="text-align:left">buy_num</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">1</td> <td style="text-align:left">购买数量</td> </tr> <tr> <td style="text-align:left">order_price</td> <td style="text-align:left">double</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">100</td> <td style="text-align:left">交易单价（单位：元）</td> </tr> <tr> <td style="text-align:left">order_type</td> <td style="text-align:left">int</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">4</td> <td style="text-align:left">订单类型：1-话费 2-流量 3-卡密 4-直充</td> </tr> <tr> <td style="text-align:left">order_state</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">success</td> <td style="text-align:left">订单状态：（success：成功，processing：处理中，failed：失败，untreated：未处理）</td> </tr> <tr> <td style="text-align:left">create_time</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">2019-07-27 16:44:30</td> <td style="text-align:left">创建时间</td> </tr> <tr> <td style="text-align:left">finish_time</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">2019-07-27 16:44:35</td> <td style="text-align:left">订单完成时间</td> </tr> <tr> <td style="text-align:left">area</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left">电信一区</td> <td style="text-align:left">充值区（中文）,仅网游直充订单返回</td> </tr> <tr> <td style="text-align:left">server</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left">逐鹿中原</td> <td style="text-align:left">充值服（中文）,仅网游直充订单返回</td> </tr> <tr> <td style="text-align:left">type</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left">Q币</td> <td style="text-align:left">计费方式（中文）,仅网游直充订单返回</td> </tr> <tr> <td style="text-align:left">cards</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left">[{\"card_number\":\"12nCp6X/nALmrvr1erxK+D4L8n/kqz/RItKWUfvZrCU=\",\"card_pwd\":\"9HeOgdv+NpLihh2+5Gm0Mj4L8n/kqz/RItKWUfvZrCU=\",\"card_deadline\":\"2019-06-30 11:15:32\",\"card_type\":0},{\"card_number\":\"12nCp6X/nALmrvr1erxK+BzfvN8D1qbXOYunJrydEWA=\",\"card_pwd\":\"9HeOgdv+NpLihh2+5Gm0MhzfvN8D1qbXOYunJrydEWA=\",\"card_deadline\":\"2019-06-30 11:15:32\",\"card_type\":0}]</td> <td style="text-align:left">卡密（券码）信息，卡密商品或部分直充商品返回（注意：卡密是密文，需要进行解密使用）；只有当订单的状态是success时，才会返回卡密（券码）信息；</td> </tr> <tr> <td style="text-align:left">    |-  card_type</td> <td style="text-align:left">int</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">0</td> <td style="text-align:left">卡类型 0.普通卡密 1.二维码 2.短链。当商品类型是卡密时，卡类型只会是0.普通卡密，不会出现1.二维码 2.短链；只有当商品类型是直充时，才会出现这三种类型。</td> </tr> <tr> <td style="text-align:left">    |-  card_number</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">12nCp6X/nALmrvr1erxK+D4L8n/kqz/RItKWUfvZrCU=</td> <td style="text-align:left">卡号</td> </tr> <tr> <td style="text-align:left">    |-  card_pwd</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">9HeOgdv+NpLihh2+5Gm0Mj4L8n/kqz/RItKWUfvZrCU=</td> <td style="text-align:left">密码</td> </tr> <tr> <td style="text-align:left">    |-  card_deadline</td> <td style="text-align:left">string</td> <td style="text-align:left">是</td> <td style="text-align:left"></td> <td style="text-align:left">2019-06-30 11:15:32</td> <td style="text-align:left">卡密有效期</td> </tr> <tr> <td style="text-align:left">operator_serial_number</td> <td style="text-align:left">string</td> <td style="text-align:left">否</td> <td style="text-align:left"></td> <td style="text-align:left"></td> <td style="text-align:left">运营商流水号</td> </tr> </tbody> </table> <h1 id="7" href="#7">响应示例</h1> <pre class="hljs"><code>直充商品： { "code": 0, "message": "接口调用成功", "result": "{\"area\":\"电信一区\",\"buy_num\":1,\"cards\":null,\"charge_account\":\"888888\",\"create_time\":\"2019-07-01 17:53:32\",\"customer_order_no\":\"201906281030191013526\",\"finish_time\":\"2019-07-01 17:53:41\",\"operator_serial_number\":\"--\",\"order_id\":\"19070134869845421753\",\"order_price\":40.0,\"order_state\":\"success\",\"order_type\":4,\"product_id\":10000373,\"product_name\":\"qb5测试代充账号功能\",\"server\":\"逐鹿中原\",\"type\":\"Q币\"}", "sign": "06f351b34d9b02bc13bc62e66bdab2c8" } 卡密商品： { "code": 0, "message": "接口调用成功", "result": "{\"area\":null,\"buy_num\":2,\"cards\":[{\"card_number\":\"12nCp6X/nALmrvr1erxK+D4L8n/kqz/RItKWUfvZrCU=\",\"card_pwd\":\"9HeOgdv+NpLihh2+5Gm0Mj4L8n/kqz/RItKWUfvZrCU=\",\"card_deadline\":\"2019-06-30 11:15:32\"},{\"card_number\":\"12nCp6X/nALmrvr1erxK+BzfvN8D1qbXOYunJrydEWA\",\"card_pwd\":\"9HeOgdv+NpLihh2+5Gm0MhzfvN8D1qbXOYunJrydEWA=\",\"card_deadline\":\"2019-06-30 11:15:32\"}],\"charge_account\":null,\"create_time\":\"2019-07-01 17:55:38\",\"customer_order_no\":\"201906281230191013521\",\"finish_time\":\"2019-07-01 17:55:41\",\"operator_serial_number\":\"\",\"order_id\":\"19070116656844081755\",\"order_price\":8.9999,\"order_state\":\"success\",\"order_type\":3,\"product_id\":10000481,\"product_name\":\"入库出库专用卡密库存不要随便使用-jfs\",\"server\":null,\"type\":null}", "sign": "d440344a46479d3fa61883bcc2f1d983" } </code></pre> <h1 id="8" href="#8">异常示例</h1> <pre class="hljs"><code>{ "code": 4011, "message": "订单不存在", "result": "", "sign": "" } </code></pre> <h1 id="9" href="#9">业务错误码</h1> <table> <thead> <tr> <th style="text-align:left">错误码</th> <th style="text-align:left">返回码描述</th> <th style="text-align:left">解决方案</th> </tr> </thead> <tbody> <tr> <td style="text-align:left">0</td> <td style="text-align:left">接口调用成功</td> <td style="text-align:left">接口调用成功，按正常流程处理；下单接口中，接口调用成功表示下单成功，但是下单成功不表示订单充值成功，要想获得订单的充值结果，需要调用查单接口来获得订单充值状态。</td> </tr> <tr> <td style="text-align:left">1000</td> <td style="text-align:left">必须传入API接口名称</td> <td style="text-align:left">错误原因： 接口请求时method参数不能为空，必须传入API接口名称参数； 解决方案： 1、在开放平台在线调试获取模拟请求参数，进行方法名比对；</td> </tr> <tr> <td style="text-align:left">1001</td> <td style="text-align:left">无效的API接口名称</td> <td style="text-align:left">错误原因： 接口请求时method接口名称错误或不存在； 解决方案： 1、以开放平台具体接口的method为准，替换请求参数中method的接口名称；</td> </tr> <tr> <td style="text-align:left">1002</td> <td style="text-align:left">必须传入时间戳</td> <td style="text-align:left">错误原因： 接口请求时timestamp参数不能为空，必须传入时间戳参数； 解决方案： 1、在请求接口中填入timestamp参数（格式为：yyyy-MM-dd HH:mm:ss）；</td> </tr> <tr> <td style="text-align:left">1003</td> <td style="text-align:left">时间戳格式错误</td> <td style="text-align:left">错误原因： 接口请求时timestamp参数格式不正确； 解决方案： 1、时间戳格式为：yyyy-MM-dd HH:mm:ss，请按要求传入参数；</td> </tr> <tr> <td style="text-align:left">1004</td> <td style="text-align:left">时间戳已超过有效期</td> <td style="text-align:left">错误原因： 接口请求时服务器会校验请求参数的时间戳timestamp，该参数与服务器当前时间误差不能超过10分钟； 解决方案： 1、请检查入参时间戳字段是否是当前请求时间（不建议同一个包体重复请求）； 2、检查请求方服务器时间是否与北京时间同步；</td> </tr> <tr> <td style="text-align:left">1005</td> <td style="text-align:left">必须传入app_key</td> <td style="text-align:left">错误原因： 接口请求时app_key参数不能为空，必须传入app_key参数； 解决方案： 1、在请求接口中填入app_key参数(生产环境：商户控制台->应用配置->密钥管理 沙箱环境参数获取)；</td> </tr> <tr> <td style="text-align:left">1006</td> <td style="text-align:left">无效的app_key</td> <td style="text-align:left">错误原因： 接口请求时服务器会校验请求参数的app_key，判断当前app_key是否有效； 解决方案： 1、检查appkey是否复制错误； 2、沙箱环境与生产环境数据不互通； 3、沙箱环境只能使用沙箱数据； 4、以上均排查后还未能解决问题，可能是由于账号配置初始化异常，可通过更新回调地址这种方式来重置账号配置，即可解决问题；（操作步骤：登录商户控制台-配置订单回调地址）；</td> </tr> <tr> <td style="text-align:left">1007</td> <td style="text-align:left">必须传入版本号</td> <td style="text-align:left">错误原因： 接口请求时version参数不能为空，必须传入版本号； 解决方案： 1、目前的版本号参数值为：2.0；</td> </tr> <tr> <td style="text-align:left">1008</td> <td style="text-align:left">版本号错误</td> <td style="text-align:left">错误原因： 接口请求时version参数值错误； 解决方案： 1、目前的版本号参数值为：2.0；</td> </tr> <tr> <td style="text-align:left">1009</td> <td style="text-align:left">必须传入format格式</td> <td style="text-align:left">错误原因： 接口请求时format参数不能为空，必须传入format格式参数； 解决方案： 1、目前的format格式仅支持json；</td> </tr> <tr> <td style="text-align:left">1010</td> <td style="text-align:left">format格式错误</td> <td style="text-align:left">错误原因： 接口请求时format参数值错误； 解决方案： 1、目前的format格式仅支持json；</td> </tr> <tr> <td style="text-align:left">1011</td> <td style="text-align:left">必须传入编码格式</td> <td style="text-align:left">错误原因： 接口请求时charset参数不能为空，必须传入charset编码格式参数； 解决方案： 1、目前的charset编码格式仅支持utf-8；</td> </tr> <tr> <td style="text-align:left">1012</td> <td style="text-align:left">编码格式错误</td> <td style="text-align:left">错误原因： 接口请求时charset参数值错误； 解决方案： 1、目前的charset编码格式仅支持utf-8；</td> </tr> <tr> <td style="text-align:left">1013</td> <td style="text-align:left">必须传入签名加密类型</td> <td style="text-align:left">错误原因： 接口请求时sign_type参数不能为空，必须传入签名加密类型； 解决方案： 1、目前的sign_type签名加密类型支持md5和rsa；</td> </tr> <tr> <td style="text-align:left">1014</td> <td style="text-align:left">签名加密类型错误</td> <td style="text-align:left">错误原因： 接口请求时sign_type参数值错误； 解决方案： 1、目前的sign_type签名加密类型支持md5和rsa；</td> </tr> <tr> <td style="text-align:left">1015</td> <td style="text-align:left">必须传入签名</td> <td style="text-align:left">错误原因： 接口请求时sign参数不能为空，必须传入签名参数； 解决方案： 1、在请求接口中填入sign参数；</td> </tr> <tr> <td style="text-align:left">1016</td> <td style="text-align:left">签名错误</td> <td style="text-align:left">错误原因： 接口请求时服务器会校验请求参数sign的准确性，签名加密参数或方法错误； 解决方案： 1、检查接口地址是否正确，比如沙箱环境和生产环境的地址混淆； 2、检查参数名称和参数值是否按照接口文档规范要求填写； 3、参数值null做为字符串参与签名； 4、按照“签名计算规则说明”文档示例数据在本地进行加密，比对加密结果排查问题； 5、接口请求签名、接口响应签名、异步回调签名规则都是一样；</td> </tr> <tr> <td style="text-align:left">1017</td> <td style="text-align:left">必须传入请求参数集合</td> <td style="text-align:left">错误原因： 接口请求时biz_content参数不能为空，必须传入biz_content请求参数； 解决方案： 1、在请求接口中填入biz_content参数，如果没有业务参数，biz_conent的值为"{}"；</td> </tr> <tr> <td style="text-align:left">1018</td> <td style="text-align:left">缺少必要参数</td> <td style="text-align:left">错误原因： 接口请求时缺少必要参数，接口中缺失必填字段参数； 解决方案： 1、在开放平台在线调试获取模拟请求参数，进行参数比对；</td> </tr> <tr> <td style="text-align:left">1019</td> <td style="text-align:left">访问IP不在IP白名单内</td> <td style="text-align:left">错误原因： 接口请求服务器的外网IPv4格式IP地址没有添加到商户控制台->应用配置->IP白名单中； 解决方案： 请将接口响应信息中的IP地址添加进去（目前各接口没有校验IP白名单，可不必配置IP白名单）。</td> </tr> <tr> <td style="text-align:left">2003</td> <td style="text-align:left">商户或应用配置异常</td> <td style="text-align:left">错误原因： 商户控制台->应用配置->秘钥配置中的配置信息异常，导致在各接口中没有找到商户编号信息； 解决方案： 1、接口请求时没有获取到充值API应用配置的应用编号信息，请联系运营处理；</td> </tr> <tr> <td style="text-align:left">4000</td> <td style="text-align:left">必须传入外部订单号</td> <td style="text-align:left">错误原因： 下单或查单接口请求时customer_order_no参数不能为空，必须传入外部订单号参数； 解决方案： 1、在请求接口中填入customer_order_no参数；</td> </tr> <tr> <td style="text-align:left">4011</td> <td style="text-align:left">订单不存在</td> <td style="text-align:left">错误原因： 下单接口或查单接口请求时，传入的外部订单号customer_order_no不存在； 解决方案： 1、请调用查单接口持续查询订单状态。如果查单返回4011(订单不存在)，并且120分钟后，还是返回4011状态，则订单将会自动拦截按失败处理（目前此功能暂只支持可疑订单拦截白名单内的商户做此处理）此时查单接口返回的订单状态为failed。由于订单是可疑自动拦截，没有到平台底层充值，所以最终查单结果和订单异步回调信息中没有平台订单号。另外也可在订单被视为可疑订单后（大概下单40分钟后），联系运营人工处理拦截；（注意：不要轻易失败订单，请一定要查单来确认订单状态。另外订单只会保留2个月，2个月之前的订单，查询时会提示不存在）； 2、订单查询接口是必须要对接的接口，请务必实现主动查询的方式来闭环业务，而不是仅仅被动等待订单异步回调通知的方式来得到充值结果（可能因为网络波动等原因，回调有可能发不出去，或回调接口接收不到）。</td> </tr> <tr> <td style="text-align:left">4012</td> <td style="text-align:left">查询异常，请重试</td> <td style="text-align:left">错误原因： 请求用户接口、获得商品信息接口、获得商品模板接口、查单接口时，请求参数与文档不匹配； 解决方案： 在开放平台在线调试获取模拟请求参数进行参数比对，自行排查，或联系运营处理；</td> </tr> <tr> <td style="text-align:left">5001</td> <td style="text-align:left">系统异常</td> <td style="text-align:left">错误原因： 1、请求参数(值或类型)与文档不匹配； 2、系统内部异常； 解决方案： 1、开发环境： ①请求接口方式：仅支持HTTP POST请求，Content-Type必须设置为：application/json； ②biz_content参数值需要正常解析为json的字符串类型，而非对象； ③在开放平台在线调试获取模拟请求参数进行参数比对； 2、生产环境： 1、下单接口，订单下单失败，因系统异常未下单成功，订单可按失败处理； 2、其他接口，排查掉问题后，重新发起请求；</td> </tr> </tbody> </table>

请求参数

参数名

类型

描述

必填

响应参数

参数名

类型

描述

必填

说明 / 示例