API渠道服务-接口文档

API渠道服务,提供除充值API以外的标准接口能力。


基于下单时间的对账单申请

<p>[TOC]</p> <h5>业务背景</h5> <ul> <li>标准api中的对账功能基于订单完成时间维度进行处理,部分客户系统中没有存储订单完成时间,导致对账功能存在数据对不上。</li> </ul> <h5>接口描述</h5> <ul> <li>基于下单时间进行对账。</li> </ul> <h5>接口地址</h5> <ul> <li><code>/api/Order/OrderRecordGet</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>公共请求参数</h5> <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;">app_key</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>开放平台分配给商户的app_key</td> </tr> <tr> <td style="text-align: left;">method</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>接口方法名称</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>时间戳,格式为:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">version</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>调用的接口版本</td> </tr> <tr> <td style="text-align: left;">format</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>接口请求或响应格式</td> </tr> <tr> <td style="text-align: left;">charset</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>请求使用的编码格式,如utf-8等</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>签名串,签名规则详见[开放平台文档中心-接口规范-签名规则](<a href="https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=8dc03ac6-e514-4eb5-b97e-17a8991e23e1">https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=8dc03ac6-e514-4eb5-b97e-17a8991e23e1</a> &quot;开放平台文档中心&quot;)</td> </tr> <tr> <td style="text-align: left;">sign_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>签名加密类型,目前仅支持md5</td> </tr> <tr> <td style="text-align: left;">app_auth_token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>授权码,固定值为“”</td> </tr> <tr> <td style="text-align: left;">biz_content</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>请求参数集合(注意:该参数是以json字符串的形式传输)</td> </tr> </tbody> </table> <h5>业务报文参数</h5> <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;">order_record_get_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">50</td> <td>对账单单号</td> </tr> <tr> <td style="text-align: left;">begin_create_time</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">11</td> <td>对账开始时间(下单时间),格式为:yyyy-MM-dd,与对账结束时间差不能超过三个月</td> </tr> <tr> <td style="text-align: left;">end_create_time</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">11</td> <td>对账结束时间(下单时间),格式为:yyyy-MM-dd</td> </tr> <tr> <td style="text-align: left;">callback_url</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">200</td> <td>回调地址</td> </tr> </tbody> </table> <h5>公共请求参数示例</h5> <pre><code>{     &amp;quot;app_key&amp;quot;: &amp;quot;xU9Ob3ZekivWBNm8S/3jv8AC2CNVdk36siDPsPNrlU3xAZsN9Ya4UxchhkJxq3ly&amp;quot;,     &amp;quot;method&amp;quot;: &amp;quot;fulu.order.record.get&amp;quot;,     &amp;quot;timestamp&amp;quot;: &amp;quot;2025-06-25 13:52:59&amp;quot;,     &amp;quot;version&amp;quot;: &amp;quot;2.0&amp;quot;,     &amp;quot;format&amp;quot;: &amp;quot;json&amp;quot;,     &amp;quot;charset&amp;quot;: &amp;quot;utf-8&amp;quot;,     &amp;quot;sign_type&amp;quot;: &amp;quot;md5&amp;quot;,     &amp;quot;sign&amp;quot;: &amp;quot;b706a6166cd211205bf4167f75f976f8&amp;quot;,     &amp;quot;app_auth_token&amp;quot;: &amp;quot;&amp;quot;,     &amp;quot;biz_content&amp;quot;: &amp;quot;{\&amp;quot;begin_create_time\&amp;quot;:\&amp;quot;2025-06-01\&amp;quot;,\&amp;quot;end_create_time\&amp;quot;:\&amp;quot;2025-06-25\&amp;quot;,\&amp;quot;order_record_get_no\&amp;quot;:\&amp;quot;12345678910\&amp;quot;,\&amp;quot;callback_url\&amp;quot;:\&amp;quot;https://it-fulu-mall-apichannelservice-api.suuyuu.cn/api/Test/TestSuccess\&amp;quot;}&amp;quot; }</code></pre> <h5>响应参数</h5> <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;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>返回码,详见底部《业务错误码》</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>返回码描述,详见底部《业务错误码》</td> </tr> </tbody> </table> <h5>响应结果参数</h5> <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;">smsSign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">30</td> <td>短信sign</td> </tr> </tbody> </table> <h5>成功响应示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;message&amp;quot;: &amp;quot;操作成功&amp;quot; }</code></pre> <h5>异常响应示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 1016,     &amp;quot;message&amp;quot;: &amp;quot;签名错误&amp;quot; }</code></pre> <h5>业务错误码</h5> <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;">0</td> <td style="text-align: left;">接口调用成功</td> <td>接口调用成功,按正常流程处理</td> </tr> <tr> <td style="text-align: left;">1000</td> <td style="text-align: left;">必须传入API接口名称</td> <td>请检查请求参数method是否为空</td> </tr> <tr> <td style="text-align: left;">1001</td> <td style="text-align: left;">无效的API接口名称</td> <td>以开放平台具体接口的method为准,替换请求参数中method的接口名称;</td> </tr> <tr> <td style="text-align: left;">1002</td> <td style="text-align: left;">必须传入时间戳</td> <td>检查公共参数中是否传入时间戳</td> </tr> <tr> <td style="text-align: left;">1003</td> <td style="text-align: left;">时间戳格式错误</td> <td>检查公共参数中传入时间戳格式是否符合要求</td> </tr> <tr> <td style="text-align: left;">1004</td> <td style="text-align: left;">时间戳已过期</td> <td>传入最新的时间戳(与发起时间不得超过10分钟)</td> </tr> <tr> <td style="text-align: left;">1005</td> <td style="text-align: left;">必须传入app_key</td> <td>检查公共参数中是否包含app_key</td> </tr> <tr> <td style="text-align: left;">1006</td> <td style="text-align: left;">无效的app_key</td> <td>app_key无效,请联系接口提供方运营进行配置或检查app_key是否正确</td> </tr> <tr> <td style="text-align: left;">1007</td> <td style="text-align: left;">必须传入版本号</td> <td>检查是否传入版本号</td> </tr> <tr> <td style="text-align: left;">1008</td> <td style="text-align: left;">无效的版本号</td> <td>检查传入的版本号</td> </tr> <tr> <td style="text-align: left;">1009</td> <td style="text-align: left;">必须传入format</td> <td>检查是否传入format</td> </tr> <tr> <td style="text-align: left;">1010</td> <td style="text-align: left;">无效的格式</td> <td>检查传入的format</td> </tr> <tr> <td style="text-align: left;">1011</td> <td style="text-align: left;">必须传入charset</td> <td>检查是否传入charset</td> </tr> <tr> <td style="text-align: left;">1012</td> <td style="text-align: left;">无效的字符集</td> <td>检查传入的charset</td> </tr> <tr> <td style="text-align: left;">1013</td> <td style="text-align: left;">必须传入签名加密类型</td> <td>检查是否传入sign_type</td> </tr> <tr> <td style="text-align: left;">1014</td> <td style="text-align: left;">无效的签名加密类型</td> <td>检查传入的sign_type</td> </tr> <tr> <td style="text-align: left;">1015</td> <td style="text-align: left;">必须传入签名</td> <td>检查是否传入签名</td> </tr> <tr> <td style="text-align: left;">1016</td> <td style="text-align: left;">签名错误</td> <td>检查传入的签名,具体加密方式见[开放平台文档中心-接口规范-签名规则](<a href="https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=8dc03ac6-e514-4eb5-b97e-17a8991e23e1">https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=8dc03ac6-e514-4eb5-b97e-17a8991e23e1</a> &quot;开放平台文档中心&quot;)</td> </tr> <tr> <td style="text-align: left;">1017</td> <td style="text-align: left;">必须传入业务报文</td> <td>检查是否传入业务报文</td> </tr> <tr> <td style="text-align: left;">1018</td> <td style="text-align: left;">业务参数报文错误</td> <td>检查传入的业务报文</td> </tr> <tr> <td style="text-align: left;">1020</td> <td style="text-align: left;">应用密钥未配置,请联系接口提供方配置</td> <td>联系接口提供方运营进行配置</td> </tr> <tr> <td style="text-align: left;">1023</td> <td style="text-align: left;">接口权限未配置</td> <td>联系接口提供方研发进行配置</td> </tr> <tr> <td style="text-align: left;">2114</td> <td style="text-align: left;">必须传入账单获取单号</td> <td>检查是否传入账单获取单号</td> </tr> <tr> <td style="text-align: left;">2121</td> <td style="text-align: left;">开始时间或结束时间错误</td> <td>时间格式为:yyyy-MM-dd,开始时间不能大于结束时间且时间差不能超过3个月</td> </tr> <tr> <td style="text-align: left;">3001</td> <td style="text-align: left;">发起对账请求失败</td> <td>重试</td> </tr> <tr> <td style="text-align: left;">5001</td> <td style="text-align: left;">系统异常</td> <td>排查问题后重试</td> </tr> </tbody> </table>

页面列表

ITEM_HTML