乐收赢API

银飞乐收赢接口文档


小程序支付接口

<p><strong>接口描述:</strong> </p> <ul> <li>用于微信、支付宝在小程序的环境下,唤起支付功能的支付场景</li> </ul> <p><strong>接口URL:</strong> </p> <ul> <li>测试<code>https://test.gdyfsk.com/yfpay/v3/minipay</code></li> <li>正式<code>https://open.gdyfsk.com/yfpay/v3/minipay</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>请求头部:</strong></p> <table> <thead> <tr> <th>标签</th> <th>必填</th> <th>内容</th> </tr> </thead> <tbody> <tr> <td>Content-Type</td> <td>是</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: center;">类型</th> <th style="text-align: center;">必填</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: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">机构号</td> <td>900075</td> </tr> <tr> <td style="text-align: left;">mch_no</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">商户号</td> <td>Y52211090004</td> </tr> <tr> <td style="text-align: left;">shop_no</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">门店号</td> <td>86000033007</td> </tr> <tr> <td style="text-align: left;">terminal_no</td> <td style="text-align: center;">string</td> <td style="text-align: center;">否</td> <td style="text-align: left;">乐收赢终端号或设备SN</td> <td>70020283</td> </tr> <tr> <td style="text-align: left;">pay_type</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">支付类型:300支付宝,400微信</td> <td>300</td> </tr> <tr> <td style="text-align: left;">pay_trace_no</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">请求流水号(在商户系统内唯一)</td> <td>51c7d68424e5492199cf7f4734a2b977</td> </tr> <tr> <td style="text-align: left;">pay_time</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">请求支付时间,yyyyMMddHHmmss格式</td> <td>20181116155621</td> </tr> <tr> <td style="text-align: left;">total_amount</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">支付金额,单位:分</td> <td>100</td> </tr> <tr> <td style="text-align: left;">open_id</td> <td style="text-align: center;">string</td> <td style="text-align: center;">C</td> <td style="text-align: left;">用户标识(微信openid/支付宝userid),走小程序插件时不传</td> <td>orxYXv8u8H4i2K0uB6RVXZ_-l7ZU</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">微信小程序的appid(此处取值优先于后台配置)</td> <td>wxbca6c935a45dcdc5</td> </tr> <tr> <td style="text-align: left;">order_body</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">订单描述</td> <td>苹果笔记本</td> </tr> <tr> <td style="text-align: left;">attach</td> <td style="text-align: center;">string</td> <td style="text-align: center;">C</td> <td style="text-align: left;">自定义参数,原样返回,特定参数:“assPost”-走小程序插件,&quot;T_APP&quot;微信直连小程序</td> <td>1234</td> </tr> <tr> <td style="text-align: left;">channel_type</td> <td style="text-align: center;">string</td> <td style="text-align: center;">C</td> <td style="text-align: left;">渠道ID,小程序码牌时使用</td> <td>1234</td> </tr> <tr> <td style="text-align: left;">notify_url</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">回调地址(以http或https开头的完整url地址)</td> <td></td> </tr> <tr> <td style="text-align: left;">undiscount_amount</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">不参与打折金额,单位:分</td> <td>100</td> </tr> <tr> <td style="text-align: left;">food_order_type</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">点餐场景类型(针对小程序扫码点餐专用)</td> <td>qr_order(店内扫码点餐),pre_order(预点到店自提),home_delivery (外送到家),direct_payment(直接付款),other(其他)</td> </tr> <tr> <td style="text-align: left;">goods_detail</td> <td style="text-align: center;">object</td> <td style="text-align: center;"></td> <td style="text-align: left;">详情内容,json格式的字符串</td> <td>&quot;[{\&quot;goods_id\&quot;: \&quot;8001 \&quot;,\&quot;goods_name\&quot;: \&quot;苹果 \&quot;,\&quot;goods_price\&quot;: \&quot;200 \&quot;,\&quot;goods_quantity\&quot;: \&quot;1\&quot;}, {\&quot;goods_id\&quot;: \&quot;8002\&quot;,\&quot;goods_name\&quot;: \&quot;雪花\&quot;,\&quot;goods_price\&quot;: \&quot;300 \&quot;,\&quot;goods_quantity\&quot;: \&quot;1\&quot;}]&quot;</td> </tr> <tr> <td style="text-align: left;">--goods_id</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">商品编号</td> <td>8005</td> </tr> <tr> <td style="text-align: left;">--goods_name</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">商品名称</td> <td>苹果</td> </tr> <tr> <td style="text-align: left;">--goods_quantity</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">商品数量</td> <td>1</td> </tr> <tr> <td style="text-align: left;">--goods_price</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">商品单价,单位:分</td> <td>100</td> </tr> <tr> <td style="text-align: left;">share_type</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">1.同步分账 2.异步分账</td> <td>0</td> </tr> <tr> <td style="text-align: left;">share_detail</td> <td style="text-align: center;">object</td> <td style="text-align: center;"></td> <td style="text-align: left;">分账详情,json格式的字符串</td> <td>&quot;{\&quot;share_count\&quot;:\&quot;2\&quot;,\&quot;share_fee_mch\&quot;:\&quot;851811130002\&quot;,\&quot;share_array\&quot;:[{\&quot;share_mch\&quot;:\&quot;851811130002\&quot;,\&quot;share_amount\&quot;:\&quot;122\&quot;},{\&quot;share_mch\&quot;:\&quot;851811130003\&quot;,\&quot;share_amount\&quot;:\&quot;322\&quot;}]}&quot;</td> </tr> <tr> <td style="text-align: left;">--share_count</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">分账条目数</td> <td>2</td> </tr> <tr> <td style="text-align: left;">--share_fee_mch</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">承担手续费的商户</td> <td>851811130002</td> </tr> <tr> <td style="text-align: left;">--share_array</td> <td style="text-align: center;">array</td> <td style="text-align: center;"></td> <td style="text-align: left;">分账数组,json数组</td> <td></td> </tr> <tr> <td style="text-align: left;">----share_mch</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">分账商户号</td> <td>851811130002</td> </tr> <tr> <td style="text-align: left;">----share_amount</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">分账金额,单位:分</td> <td>122</td> </tr> <tr> <td style="text-align: left;">reqip</td> <td style="text-align: center;">string</td> <td style="text-align: center;"></td> <td style="text-align: left;">请求ip</td> <td>220.181.108.156</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: center;">string</td> <td style="text-align: center;">是</td> <td style="text-align: left;">签名字符串,拼装所有值不为空(为null不参与,空字符串参与)</td> <td>51c7d68424e5492199cf7f4734a2b977</td> </tr> </tbody> </table> <p><code>备注:</code> sign 字段传递参数按照字典序用&amp;符号连接最后拼接机构key,UTF-8编码,32位md5加密转换, 示例:a=1&amp;b=1&amp;c=1&amp;d=1&amp;key=51c7d68424e5492199cf7f4734a2b977,详细见 [接入指引](<a href="https://www.showdoc.com.cn/leshouying/10788371225650114">https://www.showdoc.com.cn/leshouying/10788371225650114</a> &quot;接入指引&quot;)</p> <p><strong>请求示例:</strong></p> <pre><code class="language-json">{ &amp;quot;inst_no&amp;quot;: 900075, &amp;quot;mch_no&amp;quot;: &amp;quot;Y52211090004&amp;quot;, &amp;quot;pay_type&amp;quot;: &amp;quot;400&amp;quot;, &amp;quot;pay_trace_no&amp;quot;: &amp;quot;113332313422343002&amp;quot;, &amp;quot;pay_time&amp;quot;: &amp;quot;20480776150904&amp;quot;, &amp;quot;total_amount&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;openid&amp;quot;: &amp;quot;afcdasdasdasd3213dxdasdad&amp;quot;, &amp;quot;order_body&amp;quot;: &amp;quot;银飞测试&amp;quot;, &amp;quot;attach&amp;quot;: &amp;quot;888&amp;quot;, &amp;quot;sign&amp;quot;: &amp;quot;6e461f5c95c055b3aed017b8fcb8a1a9&amp;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</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</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</td> <td style="text-align: left;">是</td> <td style="text-align: left;">业务结果:PAY_SUCCESS 支付成功 ,PAY_IN_PROCESS 支付中 ,PAY_FAIL 支付失败,只有在return_code为SUCCESS时才会返回。</td> <td>PAY_SUCCESS</td> </tr> <tr> <td style="text-align: left;">mch_no</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">商户号</td> <td>Y52211090004</td> </tr> <tr> <td style="text-align: left;">shop_no</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">门店号</td> <td>86000033007</td> </tr> <tr> <td style="text-align: left;">mch_name</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">商户名称</td> <td>银飞测试</td> </tr> <tr> <td style="text-align: left;">shop_name</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">门店名称</td> <td>1号店</td> </tr> <tr> <td style="text-align: left;">pay_type</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">支付类型:300支付宝,400微信</td> <td>300</td> </tr> <tr> <td style="text-align: left;">pay_trace_no</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">请求流水号(必须在商户系统内唯一)</td> <td>51c7d68424e5492199cf7f4734a2b977</td> </tr> <tr> <td style="text-align: left;">pay_time</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">请求交易时间,yyyyMMddHHmmss</td> <td>20181116155621</td> </tr> <tr> <td style="text-align: left;">total_amount</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">支付金额,单位:分</td> <td>100</td> </tr> <tr> <td style="text-align: left;">trade_no</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">订单号</td> <td>20000002814118090716435200001</td> </tr> <tr> <td style="text-align: left;">attach</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">扩展字段原样返回</td> <td>1234</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,小程序appId</td> <td></td> </tr> <tr> <td style="text-align: left;">timeStamp</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,时间戳,部分系统取到的值为毫秒级,需要转换成秒(10位数字)。</td> <td>1414561699</td> </tr> <tr> <td style="text-align: left;">nonceStr</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,随机字符串</td> <td>1234</td> </tr> <tr> <td style="text-align: left;">packages</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,订单详情扩展字符串,统一下单接口返回的prepay_id参数值,提交格式:prepay_id=</td> <td>prepay_id=123456789</td> </tr> <tr> <td style="text-align: left;">signType</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,签名方式</td> <td>MD5,RSA</td> </tr> <tr> <td style="text-align: left;">paySign</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">微信小程序支付返回字段,签名</td> <td></td> </tr> <tr> <td style="text-align: left;">ali_trade_no</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">支付宝小程序支付返回字段用于调起支付宝小程序支付控件</td> <td></td> </tr> <tr> <td style="text-align: left;">miniapp_data</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td style="text-align: left;">小程序插件扩展参数,参数中【path】字段值使用固定值,如“/pages/cashier/cashier?p=XXX”, XXX是乐收赢订单号</td> <td></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;">签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换签名字符串</td> <td>51c7d68424e5492199cf7f4734a2b977</td> </tr> </tbody> </table> <p><strong>返回示例:</strong></p> <p>成功返回内容:无</p>

页面列表

ITEM_HTML