1. 商户接口
| 日期 | 接口 | 内容 |
|---|---|---|
| 2016-11-18 | 创建、更新、查询商户 | 新增更多商户费率可选,新增D0费率表,新增D0开通状态字段 |
| 2016-11-17 | 创建、更新、查询商户 | 新增本人手持身份证照片字段 |
| 2016-12-09 | 创建、更新、查询商户 | 新增限制信用卡使用字段 |
| 2016-12-13 | 创建终端 | 门店编号字段更新为非必填 |
| 2017-01-18 | 创建、更新、查询商户 | 手持营业执照合影照片及本人手持身份证照片更新为两个字段必传其中一个 |
| 2017-03-03 | 创建、更新、查询商户 | 新增负责人电话、客服电话、法人名称字段 |
| 2017-03-03 | 查询 | 新增业务结果字段 |
| 2017-03-03 | 新增创建、修改、查询门店接口 | |
| 2017-03-08 | 新增对帐单下载接口 | |
| 2017-06-13 | 对帐单下载 | 对帐单中去除机构号 |
| 2018-01-03 | 创建、更新、查询商户 | 接口全面升级为2.0版本 |
| 2018-07-02 | 创建商户接口 | 新增蓝海字段 |
| 2018-07-31 | 商户接口 | merchant_person字段长度的修改 |
| 2018-08-07 | 微信参数配置以及查询接口 | 新增微信参数配置以及查询接口 |
| 2018-08-14 | 创建、更新商户接口 | 新增业务员门头合照,业务员门店海报合照,绿洲活动补充材料(绿洲商户) |
| 2018-08-31 | 商户查询接口,微信参数配置接口 | 商户查询接口返回参数新增蓝海状态,绿洲驳回原因,蓝海驳回原因;微信参数配置接口返回新增支付appid,关注appid,支付授权目录配置状态 |
| 2018-09-13 | 创建,更新,查询商户接口 | 新增阶梯费率模版 |
| 2018-09-20 | 创建,更新 | 新增绿洲承诺函,绿洲食品卫生许可证两张照片(非必填字段) |
| 2018-12-04 | 新增商户子商户信息查询接口 | |
| 2018-12-29 | 创建终端,查询终端接口 | 新增终端简称字段 |
| 2019-03-08 | 商户创建接口 | 费率模版调整 |
| 2019-06-24 | 商户创建,更新接口 | 双账户相关字段添加 |
| 2020-03-09 | 商户类、终端类更新接口 | 添加版本号api_ver |
| 2020-03-09 | 商户类接口更新 | 删除绿洲蓝海相关字段 |
| 2020-04-24 | 商户类接口更新 | 删除创建商户、更新商户中appid相关字段 |
| 2020-04-24 | 商户类接口更新 | 新增商户变更类接口 |
1.1. 创建商户
- URL:
/merchant/200/add - Method:
POST
请求参数
| 参数名称 | 类型 | 字符长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_name | String | 50 | Y | 商户名称,扫呗系统全局唯一不可重复,最多50个汉字且不能包含特殊符号参考验重接口 |
| merchant_alias | String | 15 | Y | 商户简称,最多15个汉字且不能包含特殊符号 |
| merchant_company | String | 30 | Y | 商户注册名称/公司全称,须与营业执照名称保持一致,最多30个汉字且不能包含特殊符号 |
| merchant_province | String | 10 | Y | 所在省 |
| merchant_province_code | String | 3 | Y | 省编码 |
| merchant_city | String | 10 | Y | 所在市 |
| merchant_city_code | String | 4 | Y | 市编码 |
| merchant_county | String | 16 | Y | 所在区县 |
| merchant_county_code | String | 4 | Y | 所在区县编码 |
| merchant_address | String | 200 | Y | 商户详细地址 |
| merchant_person | String | 10 | Y | 商户联系人姓名 |
| merchant_phone | String | 13 | Y | 商户联系人电话(唯一) |
| merchant_email | String | 50 | Y | 商户联系人邮箱(唯一) |
| merchant_service_phone | String | 13 | N | 客服电话 |
| daily_timely_status | Int | 10 | N | D1状态,0不开通,1开通 |
| daily_timely_code | String | 20 | N | D1手续费代码,取值范围见下面D1费率表 |
| business_name | String | 50 | Y | 行业类目名称 |
| business_code | String | 4 | Y | 行业类目编码,由扫呗技术支持提供表格 |
| merchant_business_type | Int | 2 | Y | 商户类型:1企业,2个体工商户,3小微商户 |
| account_type | String | 2 | Y | 账户类型,1对公,2对私 |
| settlement_type | String | 2 | Y | 结算类型:1.法人结算 2.非法人结算 |
| license_type | Int | 2 | Y | 营业证件类型:0营业执照,1三证合一,2手持身份证 |
| license_no | String | 20 | N | 营业证件号码 |
| license_expire | String | 10 | N | 营业证件到期日(格式YYYY-MM-DD) |
| artif_nm | String | 10 | N | 法人名称 |
| legalIdnum | String | 30 | N | 法人身份证号 |
| legalIdnumExpire | String | 10 | N | 法人身份证有效期(格式YYYY-MM-DD) |
| merchant_id_no | String | 30 | N | 结算人身份证号码 |
| merchant_id_expire | String | 8 | N | 结算人身份证有效期,格式YYYYMMDD,长期填写29991231 |
| account_name | String | 100 | Y | 入账银行卡开户名(结算人姓名/公司名) |
| account_no | String | 25 | Y | 入账银行卡卡号 |
| account_phone | String | 30 | N | 入账银行预留手机号 |
| bank_name | String | 50 | Y | 入账银行卡开户支行 |
| bank_no | String | 25 | Y | 开户支行联行号,由扫呗技术支持提供表格 |
| company_account_name | String | 100 | N | 对公户结算账户开户名 |
| company_account_no | String | 25 | N | 对公户结算账户开户号 |
| company_bank_name | String | 50 | N | 对公户结算账户开户支行 |
| company_bank_no | String | 25 | N | 对公户结算账户开户支行联行号,由扫呗技术支持提供表格 |
| settle_type | String | 2 | Y | 清算类型:1自动结算;2手动结算, |
| rate_code | String | 10 | N | 支付费率代码,默认千分之六,取值范围见下面支付费率表 |
| img_license | String | 255 | N | 营业执照照片 |
| img_merchant_person_idcard | String | 255 | N | 商户联系人身份证照片(正面) |
| img_idcard_a | String | 255 | N | 法人身份证正面照片 |
| img_idcard_b | String | 255 | N | 法人身份证反面照片 |
| img_bankcard_a | String | 255 | N | 入账银行卡正面照片 |
| img_bankcard_b | String | 255 | N | 入账银行卡反面照片 |
| img_logo | String | 255 | N | 商户门头照片 |
| img_indoor | String | 255 | N | 内部前台照片 |
| img_contract | String | 255 | N | 店内环境照片 |
| img_other | String | 255 | N | 其他证明材料 |
| img_idcard_holding | String | 255 | N | 本人手持身份证照片 |
| img_open_permits | String | 255 | N | 开户许可证照片 |
| img_org_code | String | 255 | N | 组织机构代码证照片 |
| img_tax_reg | String | 255 | N | 税务登记证照片 |
| img_unincorporated | String | 255 | N | 入账非法人证明照片 |
| img_private_idcard_a | String | 255 | N | 对私账户身份证正面照片 |
| img_private_idcard_b | String | 255 | N | 对私账户身份证反面照片 |
| img_standard_protocol | String | 255 | N | 商户总分店关系证明 |
| img_val_add_protocol | String | 255 | N | 商户增值协议照片 |
| img_sub_account_promiss | String | 255 | N | 分账承诺函 |
| img_cashier | String | 255 | N | 微信支付物料照片 |
| img_3rd_part | String | 255 | N | 第三方平台截图 |
| img_alicashier | String | 255 | N | 支付宝支付物料照片 |
| img_salesman_logo | String | 255 | N | 业务员门头合照 |
| img_union_materiel | String | 255 | N | 云闪付营销物料布放照片 |
| notify_url | String | 255 | N | 审核状态通知地址 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
入网资料表
- √表示必填,×表示不填,-表示非必填,文字标识必填;
| 入网类型 | 字段名 | 企业对公结算 | 企业对私法人结算 | 企业对私非法人结算 | 个体户对公结算 | 个体户对私法人结算 | 个体户对私非法人结算 | 小微商户对私结算 |
|---|---|---|---|---|---|---|---|---|
| 入网类型(1企业、2个体工商户、3小微商户) | merchant_business_type | 1 | 1 | 1 | 2 | 2 | 2 | 3 |
| 结算类型(1对公、2对私) | account_type | 1 | 2 | 2 | 1 | 2 | 2 | 2 |
| 结算账户(1法人、2非法人) | settlement_type | 1 | 1 | 2 | 1 | 1 | 2 | 1 |
| 商户名称 | merchant_name | √ | √ | √ | √ | √ | √ | √ |
| 商户简称 | merchant_alias | √ | √ | √ | √ | √ | √ | √ |
| 商户注册名称/公司全称(营业执照名称) | merchant_company | √ | √ | √ | √ | √ | √ | √ |
| 所在省 | merchant_province | √ | √ | √ | √ | √ | √ | √ |
| 所在市 | merchant_city | √ | √ | √ | √ | √ | √ | √ |
| 所在县 | merchant_county | √ | √ | √ | √ | √ | √ | √ |
| 商户地址(详细地址) | merchant_address | √ | √ | √ | √ | √ | √ | √ |
| 商户联系人姓名 | merchant_person | √ | √ | √ | √ | √ | √ | √ |
| 联系人邮箱(唯一) | merchant_email | √ | √ | √ | √ | √ | √ | √ |
| 联系人电话(唯一) | merchant_phone | √ | √ | √ | √ | √ | √ | √ |
| 客服电话 | merchant_service_phone | - | - | - | - | - | - | - |
| 一级行业 | √ | √ | √ | √ | √ | √ | √ | |
| 二级行业 | √ | √ | √ | √ | √ | √ | √ | |
| 三级行业 | business_name | √ | √ | √ | √ | √ | √ | √ |
| 营业执照注册号或者社会信用代码 | license_no | √ | √ | √ | √ | √ | √ | × |
| 营业执照有效期 | license_expire | - | - | - | - | - | - | × |
| 法人姓名 | artif_nm | √ | × | √ | √ | × | √ | × |
| 法人身份证号码 | legalIdnum | √ | × | √ | √ | × | √ | × |
| 法人身份证有效期 | legalIdnumExpire | - | × | - | - | × | - | × |
| 结算人证件号码 | merchant_id_no | × | √ | √ | × | √ | √ | √ |
| 结算人证件有效期 | merchant_id_expire | × | - | - | × | - | - | - |
| 入账银行卡开户名(结算人姓名/公司名) | account_name | √ | √ | √ | √ | √ | √ | √ |
| 入账银行卡卡号 | account_no | √ | √ | √ | √ | √ | √ | √ |
| 入账银行卡开户支行 | bank_name | √ | √ | √ | √ | √ | √ | √ |
| 银行预留手机号 | account_phone | - | - | - | - | - | - | - |
| 对公户结算账户开户名 | company_account_name | - | √ | √ | - | - | - | - |
| 对公户结算账户开户号 | company_account_no | - | √ | √ | - | - | - | - |
| 对公户结算账户开户支行 | company_bank_name | - | √ | √ | - | - | - | - |
| 对公户结算账户开户支行联行号 | company_bank_no | - | √ | √ | - | - | - | - |
| 结算费率 | rate_code | √ | √ | √ | √ | √ | √ | √ |
| 智慧餐饮 | greenstatus | - | - | - | - | - | - | × |
| 蓝海开关 | blueseastatus | - | - | - | - | - | - | × |
| 营业证件类型 | license_type | √ | √ | √ | √ | 1 | 1 | 2 |
| 营业执照(三证合一) | img_license | √ | √ | √ | √ | √ | √ | × |
| 营业执照(非三证合一) | img_license | √ | √ | √ | √ | × | × | × |
| 法人身份证正面照片 | img_idcard_a | √ | × | √ | √ | × | √ | × |
| 法人身份证反面照片 | img_idcard_b | √ | × | √ | √ | × | √ | × |
| 入账银行卡正面照片 | img_bankcard_a | × | √ | √ | × | √ | √ | √ |
| 入账银行卡反面照片 | img_bankcard_b | - | - | - | - | - | - | - |
| 门头照片 | img_logo | √ | √ | √ | √ | √ | √ | √ |
| 门脸(内设)照片(前台) | img_indoor | √ | √ | √ | √ | √ | √ | √ |
| 其他材料 | img_other | - | - | - | - | - | - | - |
| 手持身份证 | img_idcard_holding | × | × | × | × | × | × | √ |
| 开户许可证照片 | img_open_permits | √ | √ | √ | √ | × | × | × |
| 组织机构代码证照片(非三证合一) | img_org_code | √ | √ | √ | √ | × | × | × |
| 税务登记证照片(非三证合一) | img_tax_reg | √ | √ | √ | √ | × | × | × |
| 入账非法人证明照片 | img_unincorporated | × | × | √ | × | × | √ | × |
| 对私账户身份证正面照片 | img_private_idcard_a | × | √ | √ | × | √ | √ | √ |
| 对私账户身份证反面照片 | img_private_idcard_b | × | √ | √ | × | √ | √ | √ |
| 商户总分店关系证明 | img_standard_protocol | - | - | - | - | - | - | - |
| 商户增值协议照片 | img_val_add_protocol | - | - | - | - | - | - | - |
| 分账承诺函 | img_sub_account_promiss | × | × | × | × | × | × | × |
支付费率代码表rate_code(为规范交易费率的配置和使用,对未及时配置费率白名单的账户,我司默认可使用0.38%-0.6%区间费率)
| 代码 | 费率(‱,万分之) | 代码 | 费率(‱,万分之) |
|---|---|---|---|
| M0025 | 25 | M0100 | 100 |
| M0026 | 26 | M0120 | 120 |
| M0027 | 27 | M0150 | 150 |
| M0028 | 28 | M0180 | 180 |
| M0029 | 29 | M0200 | 200 |
| M0030 | 30 | M0250 | 250 |
| M0031 | 31 | M0300 | 300 |
| M0032 | 32 | M0350 | 350 |
| M0033 | 33 | M0400 | 400 |
| M0034 | 34 | M0450 | 450 |
| M0035 | 35 | M0500 | 500 |
| M0036 | 36 | M0550 | 550 |
| M0037 | 37 | M0600 | 600 |
| M0038 | 38 | M0650 | 650 |
| M0039 | 39 | M0700 | 700 |
| M0040 | 40 | M0750 | 750 |
| M0041 | 41 | M0800 | 800 |
| M0042 | 42 | M0850 | 850 |
| M0043 | 43 | M0900 | 900 |
| M0044 | 44 | M0950 | 950 |
| M0045 | 45 | M1000 | 1000 |
| M0046 | 46 | M1050 | 1050 |
| M0047 | 47 | M1100 | 1100 |
| M0048 | 48 | M1150 | 1150 |
| M0049 | 49 | M1200 | 1200 |
| M0050 | 50 | M1250 | 1250 |
| M0051 | 51 | M1300 | 1300 |
| M0052 | 52 | M1400 | 1400 |
| M0053 | 53 | M1500 | 1500 |
| M0054 | 54 | M1600 | 1600 |
| M0055 | 55 | M1700 | 1700 |
| M0055 | 55 | M1800 | 1800 |
| M0056 | 56 | M1900 | 1900 |
| M0057 | 57 | ||
| M0058 | 58 | ||
| M0059 | 59 | ||
| M0060 | 60 | ||
| M0070 | 70 | ||
| M0080 | 80 | ||
| M0090 | 90 |
D1费率代码表timely_code
| 代码 | 费率 |
|---|---|
| T001010 | 0.1‰,另加收1元/笔 |
| T001020 | 0.1‰,另加收2元/笔 |
| T002010 | 0.2‰,另加收1元/笔 |
| T002020 | 0.2‰,另加收2元/笔 |
| T003005 | 0.3‰,另加收0.5元/笔 |
| T003010 | 0.3‰,另加收1元/笔 |
| T003020 | 0.3‰,另加收2元/笔 |
| T004010 | 0.4‰,另加收1元/笔 |
| T004020 | 0.4‰,另加收2元/笔 |
| T004030 | 0.4‰,另加收3元/笔 |
| T004050 | 0.4‰;另加收5元/笔 |
| T005010 | 0.5‰,另加收1元/笔 |
| T005020 | 0.5‰,另加收2元/笔 |
| T005030 | 0.5‰,另加收3元/笔 |
| T006010 | 0.6‰,另加收1元/笔 |
| T006020 | 0.6‰,另加收2元/笔 |
| T007010 | 0.7‰,另加收1元/笔 |
| T007020 | 0.7‰,另加收2元/笔 |
| T008010 | 0.8‰,另加收1元/笔 |
| T008020 | 0.8‰,另加收2元/笔 |
| T009010 | 0.9‰,另加收1元/笔 |
| T009020 | 0.9‰,另加收2元/笔 |
| T010010 | 1.0‰,另加收1元/笔 |
| T010020 | 1.0‰,另加收2元/笔 |
| T011010 | 1.1‰,另加收1元/笔 |
| T011020 | 1.1‰,另加收2元/笔 |
| T012010 | 1.2‰,另加收1元/笔 |
| T012020 | 1.2‰,另加收2元/笔 |
| T013010 | 1.3‰,另加收1元/笔 |
| T013020 | 1.3‰,另加收2元/笔 |
| T014010 | 1.4‰,另加收1元/笔 |
| T014020 | 1.4‰,另加收2元/笔 |
| T015010 | 1.5‰;另加收1元/笔 |
| T015020 | 1.5‰;另加收2元/笔 |
| T016010 | 1.6‰,另加收1元/笔 |
| T016020 | 1.6‰,另加收2元/笔 |
| T017010 | 1.7‰,另加收1元/笔 |
| T017020 | 1.7‰,另加收2元/笔 |
| T018010 | 1.8‰,另加收1元/笔 |
| T018020 | 1.8‰,另加收2元/笔 |
| T019010 | 1.9‰,另加收1元/笔 |
| T019020 | 1.9‰,另加收2元/笔 |
| T020010 | 2.0‰,另加收1元/笔 |
| T020020 | 2.0‰,另加收2元/笔 |
| T021010 | 2.1‰,另加收1元/笔 |
| T021020 | 2.1‰,另加收2元/笔 |
| T022010 | 2.2‰,另加收1元/笔 |
| T022020 | 2.2‰,另加收2元/笔 |
| T023010 | 2.3‰,另加收1元/笔 |
| T023020 | 2.3‰,另加收2元/笔 |
| T024010 | 2.4‰,另加收1元/笔 |
| T024020 | 2.4‰,另加收2元/笔 |
| T025010 | 2.5‰,另加收1元/笔 |
| T025020 | 2.5‰,另加收2元/笔 |
| T026010 | 2.6‰,另加收1元/笔 |
| T026020 | 2.6‰,另加收2元/笔 |
| T027010 | 2.7‰,另加收1元/笔 |
| T027020 | 2.7‰,另加收2元/笔 |
| T028010 | 2.8‰,另加收1元/笔 |
| T028020 | 2.8‰,另加收2元/笔 |
| T029010 | 2.9‰,另加收1元/笔 |
| T029020 | 2.9‰,另加收2元/笔 |
| T030010 | 3.0‰,另加收1元/笔 |
| T030020 | 3.0‰,另加收2元/笔 |
阶梯费率代码表timely_code
| 代码 | 费率 |
|---|---|
| N0286 | 100以下费率为0,100以上费率为2.5 |
| N0287 | 100以下费率为0,100以上费率为3 |
| N0288 | 100以下费率为0,100以上费率为3.8 |
| N0289 | 100以下费率为0,100以上费率为5.5 |
| N0290 | 100以下费率为1‰,100以上费率为2.5 |
| N0291 | 100以下费率为1‰,100以上费率为3 |
| N0292 | 100以下费率为1‰,100以上费率为3.8 |
| N0293 | 100以下费率为1‰,100以上费率为5.5 |
| N0294 | 100以下费率为1.5‰,100以上费率为2.5 |
| N0295 | 100以下费率为1.5‰,100以上费率为3 |
| N0296 | 100以下费率为1.5‰,100以上费率为3.8 |
| N0297 | 100以下费率为1.5‰,100以上费率为5.5 |
| N0298 | 100以下费率为2.1‰,100以上费率为2.5 |
| N0299 | 100以下费率为2.1‰,100以上费率为3 |
| N0300 | 100以下费率为2.1‰,100以上费率为3.8 |
| N0301 | 100以下费率为2.1‰,100以上费率为5.5 |
| N0310 | 300以下费率为0,300以上费率为2.5 |
| N0311 | 300以下费率为0,300以上费率为3 |
| N0308 | 300以下费率为0,300以上费率为3.8 |
| N0312 | 300以下费率为0,300以上费率为5.5 |
| N0313 | 300以下费率为1‰,300以上费率为2.5 |
| N0314 | 300以下费率为1‰,300以上费率为3 |
| N0315 | 300以下费率为1‰,300以上费率为3.8 |
| N0316 | 300以下费率为1‰,300以上费率为5.5 |
| N0317 | 300以下费率为1.5‰,300以上费率为2.5 |
| N0318 | 300以下费率为1.5‰,300以上费率为3 |
| N0319 | 300以下费率为1.5‰,300以上费率为3.8 |
| N0320 | 300以下费率为1.5‰,300以上费率为5.5 |
| N0321 | 300以下费率为2.1‰,300以上费率为2.5 |
| N0322 | 300以下费率为2.1‰,300以上费率为3 |
| N0323 | 300以下费率为2.1‰,300以上费率为3.8 |
| N0324 | 300以下费率为2.1‰,300以上费率为5.5 |
| N0325 | 100以下费率为0,100以上费率为2.8 |
| N0326 | 100以下费率为0,100以上费率为3.5 |
| N0327 | 100以下费率为0,100以上费率为4 |
| N0328 | 100以下费率为0,100以上费率为4.5 |
| N0329 | 100以下费率为0,100以上费率为5 |
| N0330 | 100以下费率为0,100以上费率为6 |
| N0331 | 100以下费率为1‰,100以上费率为2.8 |
| N0332 | 100以下费率为1‰,100以上费率为3.5 |
| N0333 | 100以下费率为1‰,100以上费率为4 |
| N0334 | 100以下费率为1‰,100以上费率为4.5 |
| N0335 | 100以下费率为1‰,100以上费率为5 |
| N0336 | 100以下费率为1‰,100以上费率为6 |
| N0337 | 100以下费率为1.5‰,100以上费率为2.8 |
| N0338 | 100以下费率为1.5‰,100以上费率为3.5 |
| N0339 | 100以下费率为1.5‰,100以上费率为4 |
| N0340 | 100以下费率为1.5‰,100以上费率为4.5 |
| N0341 | 100以下费率为1.5‰,100以上费率为5 |
| N0342 | 100以下费率为1.5‰,100以上费率为6 |
| N0343 | 100以下费率为2.1‰,100以上费率为2.8 |
| N0344 | 100以下费率为2.1‰,100以上费率为3.5 |
| N0345 | 100以下费率为2.1‰,100以上费率为4 |
| N0346 | 100以下费率为2.1‰,100以上费率为4.5 |
| N0347 | 100以下费率为2.1‰,100以上费率为5 |
| N0348 | 100以下费率为2.1‰,100以上费率为6 |
| N0349 | 500以下费率为0,100以上费率为2.5 |
| N0350 | 500以下费率为0,100以上费率为3 |
| N0351 | 500以下费率为0,100以上费率为3.8 |
| N0352 | 500以下费率为0,100以上费率为5.5 |
| N0353 | 500以下费率为0,100以上费率为2.8 |
| N0354 | 500以下费率为0,100以上费率为3.5 |
| N0355 | 500以下费率为0,100以上费率为4 |
| N0356 | 500以下费率为0,100以上费率为4.5 |
| N0357 | 500以下费率为0,100以上费率为5 |
| N0358 | 500以下费率为0,100以上费率为6 |
| N0359 | 500以下费率为1‰,100以上费率为2.5 |
| N0360 | 500以下费率为1‰,100以上费率为3 |
| N0361 | 500以下费率为1‰,100以上费率为3.8 |
| N0362 | 500以下费率为1‰,100以上费率为5.5 |
| N0363 | 500以下费率为1‰,100以上费率为2.8 |
| N0364 | 500以下费率为1‰,100以上费率为3.5 |
| N0365 | 500以下费率为1‰,100以上费率为4 |
| N0366 | 500以下费率为1‰,100以上费率为4.5 |
| N0367 | 500以下费率为1‰,100以上费率为5 |
| N0368 | 500以下费率为1‰,100以上费率为6 |
| N0369 | 500以下费率为1.5‰,100以上费率为2.5 |
| N0370 | 500以下费率为1.5‰,100以上费率为3 |
| N0371 | 500以下费率为1.5‰,100以上费率为3.8 |
| N0372 | 500以下费率为1.5‰,100以上费率为5.5 |
| N0373 | 500以下费率为1.5‰,100以上费率为2.8 |
| N0374 | 500以下费率为1.5‰,100以上费率为3.5 |
| N0375 | 500以下费率为1.5‰,100以上费率为4 |
| N0376 | 500以下费率为1.5‰,100以上费率为4.5 |
| N0377 | 500以下费率为1.5‰,100以上费率为5 |
| N0378 | 500以下费率为1.5‰,100以上费率为6 |
| N0379 | 500以下费率为2.1‰,100以上费率为2.5 |
| N0380 | 500以下费率为2.1‰,100以上费率为3 |
| N0381 | 500以下费率为2.1‰,100以上费率为3.8 |
| N0382 | 500以下费率为2.1‰,100以上费率为5.5 |
| N0383 | 500以下费率为2.1‰,100以上费率为2.8 |
| N0384 | 500以下费率为2.1‰,100以上费率为3.5 |
| N0385 | 500以下费率为2.1‰,100以上费率为4 |
| N0386 | 500以下费率为2.1‰,100以上费率为4.5 |
| N0387 | 500以下费率为2.1‰,100以上费率为5 |
| N0388 | 500以下费率为2.1‰,100以上费率为6 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为`01`时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:01成功 ,02失败 |
| merchant_no | String | 15 | N | 商户号 |
| key_sign | String | 32 | N | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
1.2. 商户名称验重
- URL:
/merchant/200/checkname - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_name | String | 80 | Y | 商户名称 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01名称可用 ,02商户名重复 |
| return_msg | String | 128 | Y | 返回信息提示,“签名失败”,“商户名已存在"等 |
| trace_no | String | 32 | Y | 原请求流水号 |
1.3. 更新商户资料
- URL:
/merchant/200/update - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 扫呗商户号 |
| merchant_name | String | 50 | N | 商户名称,扫呗系统全局唯一不可重复,最多50个汉字且不能包含特殊符号参考验重接口 |
| merchant_province | String | 10 | N | 所在省 |
| merchant_province_code | String | 3 | N | 省编码 |
| merchant_city | String | 10 | N | 所在市 |
| merchant_city_code | String | 4 | N | 市编码 |
| merchant_county | String | 16 | N | 所在区县 |
| merchant_county_code | String | 4 | N | 所在区县编码 |
| merchant_address | String | 200 | N | 商户详细地址 |
| merchant_person | String | 10 | N | 商户联系人姓名 |
| merchant_phone | String | 13 | N | 商户联系人电话(唯一) |
| merchant_email | String | 50 | N | 商户联系人邮箱(唯一) |
| merchant_service_phone | String | 13 | N | 客服电话 |
| business_name | String | 50 | N | 行业类目名称 |
| business_code | String | 4 | N | 行业类目编码,由扫呗技术支持提供表格 |
| merchant_business_type | Int | 2 | N | 商户类型:1企业,2个体工商户,3小微商户 |
| account_type | String | 2 | N | 账户类型,1对公,2对私 |
| settlement_type | String | 2 | N | 结算类型:1.法人结算 2.非法人结算 |
| license_type | Int | 2 | N | 营业证件类型:0营业执照,1三证合一,2手持身份证 |
| license_no | String | 20 | N | 营业证件号码 |
| license_expire | String | 10 | N | 营业证件到期日(格式YYYY-MM-DD) |
| artif_nm | String | 10 | N | 法人名称 |
| legalIdnum | String | 30 | N | 法人身份证号 |
| legalIdnumExpire | String | 10 | N | 法人身份证有效期(格式YYYY-MM-DD) |
| merchant_id_no | String | 30 | N | 结算人身份证号码 |
| merchant_id_expire | String | 8 | N | 结算人身份证有效期,格式YYYYMMDD,长期填写29991231 |
| account_name | String | 100 | N | 入账银行卡开户名(结算人姓名/公司名) |
| account_no | String | 25 | N | 入账银行卡卡号 |
| account_phone | String | 30 | N | 入账银行预留手机号 |
| bank_name | String | 50 | N | 入账银行卡开户支行 |
| bank_no | String | 25 | N | 开户支行联行号,由扫呗技术支持提供表格 |
| company_account_name | String | 100 | N | 对公户结算账户开户名 |
| company_account_no | String | 25 | N | 对公户结算账户开户号 |
| company_bank_name | String | 50 | N | 对公户结算账户开户支行 |
| company_bank_no | String | 25 | N | 对公户结算账户开户支行联行号,由扫呗技术支持提供表格 |
| img_license | String | 255 | N | 营业执照照片 |
| img_idcard_a | String | 255 | N | 负责人身份证正面照片 |
| img_idcard_b | String | 255 | N | 负责人身份证反面照片 |
| img_bankcard_a | String | 255 | N | 银行卡正面照片 |
| img_bankcard_b | String | 255 | N | 银行卡反面照片 |
| img_logo | String | 255 | N | 商户门头照片 |
| img_indoor | String | 255 | N | 内部前台照片 |
| img_contract | String | 255 | N | 店内环境照片 |
| img_other | String | 255 | N | 其他证明材料 |
| img_idcard_holding | String | 255 | N | 本人手持身份证照片 |
| img_merchant_person_idcard | String | 255 | N | 商户联系人身份证照片(正面) |
| img_open_permits | String | 255 | N | 开户许可证照片 |
| img_org_code | String | 255 | N | 组织机构代码证照片 |
| img_tax_reg | String | 255 | N | 税务登记证照片 |
| img_unincorporated | String | 255 | N | 入账非法人证明照片 |
| img_private_idcard_a | String | 255 | N | 对私账户身份证正面照片 |
| img_private_idcard_b | String | 255 | N | 对私账户身份证反面照片 |
| img_standard_protocol | String | 255 | N | 商户总分店关系证明 |
| img_val_add_protocol | String | 255 | N | 商户增值协议照片 |
| img_sub_account_promiss | String | 255 | N | 分账承诺函 |
| img_cashier | String | 255 | N | 微信支付物料照片 |
| img_3rd_part | String | 255 | N | 第三方平台截图 |
| img_alicashier | String | 255 | N | 支付宝支付物料照片 |
| img_salesman_logo | String | 255 | N | 业务员门头合照 |
| img_union_materiel | String | 255 | N | 云闪付营销物料布放照片 |
| notify_url | String | 255 | N | 审核状态通知地址 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“查询成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”修改成功 ,02”修改失败 |
| merchant_no | String | 15 | N | 商户号 |
| key_sign | String | 32 | N | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
注意:
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 10 | N | 版本号,扫呗分配(201版本为新升级版本,建议后续新接入升级此版本) |
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| key_sign | String | 32 | Y | 签名检验串,传参字典序+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“签名失败”,“商户名已存在"等 |
| trace_no | String | 32 | Y | 原请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”成功 ,02”失败 |
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| merchant_status | String | 15 | N | 商户状态,01审核通过,但未签署电子协议,02审核驳回,03审核中,05审核通过且已签署电子协议 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_business_status | Int | 2 | N | 商户合规状态,0未知,1合规,2缺少身份证,3缺少营业执照,4缺少开户许可证,5缺少营业执照和开户许可证 |
| merchant_id_type | Int | 2 | N | 证件类型 |
| timely_code | String | 32 | N | T0手续费代码 |
| timely_status | Int | 2 | N | T0开通状态,默认0不开通,1开通 |
| merchant_type | Int | 2 | N | 创建商户类型,1普通商户,2二级商户 |
| merchant_name | String | 50 | N | 商户名称,扫呗系统全局唯一不可重复 |
| merchant_alias | String | 15 | N | 商户简称 |
| merchant_company | String | 30 | N | 商户注册名称/公司全称 |
| merchant_province | String | 10 | N | 所在省 |
| merchant_province_code | String | 3 | N | 省编码 |
| merchant_city | String | 10 | N | 所在市 |
| merchant_city_code | String | 4 | N | 市编码 |
| merchant_county | String | 16 | N | 所在区县 |
| merchant_county_code | String | 4 | N | 所在区县编码 |
| merchant_address | String | 200 | N | 商户详细地址 |
| merchant_person | String | 10 | N | 商户联系人姓名 |
| merchant_phone | String | 13 | N | 商户联系人电话(唯一) |
| merchant_email | String | 50 | N | 商户联系人邮箱(唯一) |
| merchant_service_phone | String | 13 | N | 客服电话 |
| daily_timely_status | Int | 10 | N | D1状态 |
| daily_timely_code | String | 20 | N | D1手续费代码 |
| business_name | String | 50 | N | 行业类目名称 |
| business_code | String | 4 | N | 行业类目编码,由扫呗技术支持提供表格 |
| merchant_business_type | Int | 2 | N | 商户类型:1企业,2个体工商户,3小微商户 |
| account_type | String | 2 | N | 账户类型,1对公,2对私 |
| settlement_type | String | 2 | N | 结算类型:1.法人结算 2.非法人结算 |
| license_type | Int | 2 | N | 营业证件类型:0营业执照,1三证合一,2手持身份证 |
| license_no | String | 20 | N | 营业证件号码 |
| license_expire | String | 10 | N | 营业证件到期日(格式YYYY-MM-DD) |
| artif_nm | String | 10 | N | 法人名称 |
| legalIdnum | String | 30 | N | 法人身份证号 |
| legalIdnumExpire | String | 10 | N | 法人身份证有效期(格式YYYY-MM-DD) |
| merchant_id_no | String | 30 | N | 结算人身份证号码 |
| merchant_id_expire | String | 8 | N | 结算人身份证有效期,格式YYYYMMDD,长期填写29991231 |
| account_name | String | 100 | N | 入账银行卡开户名(结算人姓名/公司名) |
| account_no | String | 25 | N | 入账银行卡卡号 |
| account_phone | String | 30 | N | 入账银行预留手机号 |
| bank_name | String | 50 | N | 入账银行卡开户支行 |
| bank_no | String | 25 | N | 开户支行联行号,由扫呗技术支持提供表格 |
| rate_code | String | 10 | N | 支付费率代码,默认千分之六,取值范围见下表 |
| blueseastatus | Int | 2 | N | 商户蓝海状态,0未开通 1申请中 2已开通 9已驳回 |
| bluesea_reviewedreason | String | 255 | N | 蓝海驳回原因 |
| img_license | String | 255 | N | 营业执照照片 |
| img_idcard_a | String | 255 | N | 负责人身份证正面照片 |
| img_idcard_b | String | 255 | N | 负责人身份证反面照片 |
| img_merchant_person_idcard | String | 255 | N | 商户联系人身份证照片(正面) |
| img_bankcard_a | String | 255 | N | 银行卡正面照片 |
| img_bankcard_b | String | 255 | N | 银行卡反面照片 |
| img_logo | String | 255 | N | 商户门头照片 |
| img_indoor | String | 255 | N | 内部前台照片 |
| img_contract | String | 255 | N | 店内环境照片 |
| img_other | String | 255 | N | 其他证明材料 |
| img_idcard_holding | String | 255 | N | 本人手持身份证照片 |
| img_open_permits | String | 255 | N | 开户许可证照片 |
| img_org_code | String | 255 | N | 组织机构代码证照片 |
| img_tax_reg | String | 255 | N | 税务登记证照片 |
| img_unincorporated | String | 255 | N | 入账非法人证明照片 |
| img_private_idcard_a | String | 255 | N | 对私账户身份证正面照片 |
| img_private_idcard_b | String | 255 | N | 对私账户身份证反面照片 |
| img_standard_protocol | String | 255 | N | 商户总分店关系证明 |
| img_val_add_protocol | String | 255 | N | 商户增值协议照片 |
| img_sub_account_promiss | String | 255 | N | 分账承诺函 |
| img_cashier | String | 255 | N | 微信支付物料照片 |
| img_3rd_part | String | 255 | N | 第三方平台截图 |
| notify_url | String | 255 | N | 审核状态通知地址 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
1.5. 商户微信认证状态查询接口
- URL:
/merchant/200/querywxstatus - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”创建成功 ,02”创建失败 |
| merchant_no | String | 15 | N | 商户号 |
| authentication_status | String | 1 | Y | 微信商户认证状态:0未申请 1微信审核中 2待联系人确认 3待法人确认 4微信审核通过(待授权) 5已授权 6已驳回 |
| qrcode_data | String | 2048 | N | 微信授权二维码链接( 状态为 2待联系人确认 3待法人确认 4微信审核通过(待授权) 才返回) |
| reject_reason | String | 256 | N | 驳回原因 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.6. 创建门店
- URL:
/store/100/add - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 商户号 |
| store_name | String | 50 | Y | 门店名称 |
| store_addre | String | 150 | N | 门店地址 |
| store_person | String | 10 | N | 门店联系人 |
| store_phone | String | 11 | Y | 门店联系手机号码。(手机号码) |
| store_email | String | 50 | Y | 门店联系邮箱。(邮箱和手机号码选填一个,全局唯一,作为登录账号) |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”创建成功 ,02”创建失败 |
| merchant_no | String | 15 | N | 商户号 |
| store_code | String | 15 | N | 门店编号 |
| store_name | String | 50 | N | 门店名称 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.7. 修改门店
- URL:
/store/100/update - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 商户号 |
| store_code | String | 15 | Y | 门店编号 |
| store_name | String | 50 | N | 门店名称 |
| store_addre | String | 150 | N | 门店地址 |
| store_person | String | 10 | N | 门店联系人 |
| store_phone | String | 11 | N | 门店联系手机号码。(手机号码) |
| store_email | String | 50 | N | 门店联系邮箱。(邮箱和手机号码选填一个,全局唯一,作为登录账号) |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”修改成功 ,02”修改失败 |
| merchant_no | String | 15 | N | 商户号 |
| store_code | String | 15 | N | 门店编号 |
| store_name | String | 50 | N | 门店名称 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.8. 查询门店
- URL:
/store/100/query - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 商户号 |
| store_code | String | 15 | Y | 门店编号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”查询成功,“02”查询失败 |
| merchant_no | String | 15 | N | 商户号 |
| merchant_name | String | 80 | N | 商户名称 |
| store_code | String | 15 | N | 门店编号 |
| store_name | String | 80 | N | 门店名称 |
| store_addre | String | 150 | N | 门店地址 |
| store_person | String | 10 | N | 门店联系人 |
| store_phone | String | 11 | N | 门店联系手机号码。 |
| store_email | String | 50 | N | 门店联系邮箱。 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.9. 创建终端
- URL:
/terminal/100/add - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | Y | 商户号 |
| store_code | String | 15 | N | 门店编号 |
| terminal_name | String | 20 | N | 终端简称 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“创建成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”创建成功 ,02”创建失败 |
| merchant_no | String | 15 | N | 商户号 |
| store_code | String | 15 | N | 门店编号 |
| terminal_id | String | 15 | N | 终端号 |
| access_token | String | 32 | N | 令牌 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.10. 查询终端
- URL:
/terminal/100/query - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| api_ver | String | 10 | N | 版本号,扫呗分配(200版本为新升级版本,建议后续新接入升级此版本) |
| merchant_no | String | 15 | N | 商户号(当版本号api_ver为200时,此字段必传) |
| trace_no | String | 32 | Y | 请求流水号 |
| terminal_id | String | 15 | Y | 终端号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“查询成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”查询成功 ,02”查询失败 |
| merchant_no | String | 15 | N | 商户号 |
| merchant_name | String | 80 | N | 商户名称,扫呗系统全局唯一不可重复 |
| store_code | String | 15 | N | 门店编号 |
| store_name | String | 80 | N | 门店名称,扫呗系统全局唯一不可重复 |
| terminal_id | String | 15 | N | 终端号 |
| terminal_name | String | 20 | N | 终端简称 |
| access_token | String | 32 | N | 令牌 |
| key_sign | String | 32 | N | 签名检验串,拼装所有必填参数+令牌,32位md5加密转换 |
1.11. 商户回调通知
1.商户审核通知:合作方通过成功调用“创建商户”接口后,扫呗会对新商户资料进行审核,审核完成后向提交者通知审核结果。
2.商户电子协议签署通知:商户入网成功后,需签署电子协议,签署结果通过商户入网时填写的notify_url通知调用方。
注明:此接口指由扫呗服务器发出,调用方按照notify_url字段指定的地址负责接收通知结果并且必须按下文的“返回参数”要求回应扫呗。
- URL:商户入网时
notify_url字段的值 - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“查询成功”,“请求受限”,"签署成功","签署失败"等 |
| trace_no | String | 32 | Y | 请求流水号 |
| result_code | String | 2 | Y | 业务结果:01商户审核通过 ,02商户审核驳回, 03电子协议签署成功,04电子协议签署失败 |
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| merchant_no | String | 15 | Y | 商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有必传参数+令牌,32位md5加密转换(必传参数文档序) |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“处理成功”,“处理失败”等 |
| trace_no | String | 32 | Y | 原通知流水号 |
1.12. 对帐单下载
- URL:
https://example.com/order/day/inst_no/key_sign/inst_no_day.txt - Method:
GET
请求路径中example.com只是个示例,请联系对接人员获取真实域名。请求路径中除了/、order和.txt,其它全部是变量名,在实际请求中需要替换成变量的值,示例如下:
https://example.com/order/20170208/00000001/a988b4b22559754ffe5c32e227872a7a/00000001_20170208.txt
对账单示例:
813400153000655,10095942,2017-02-26 10:40:30,2017-02-26 10:40:31,59400,-226,59400,-59400,1,1,5,100959420622017022610403001456,100959420321117022511123900313,20170225111239392730,,2017-02-26,oGRo8xM_-MoGpvoFUaGxYDL7xAEQ,0,,
865100292000051,10086757,2017-01-22 12:47:30,2017-01-22 12:47:31,60600,-182,60600,-60600,1,3,5,100867600122017012212473001653,100867570421317012212463201871,,,2017-01-22,oAisZs-IhQSdUY9iqae6-eV8ECbs,0,,
865100292000051,10086757,2017-01-22 12:46:33,,60600,182,0,60600,1,3,1,100867570421317012212463201871,,,4000782001201701227175028928,2017-01-22,oAisZs-IhQSdUY9iqae6-eV8ECbs,0,,
813400153000655,10095942,2017-02-25 11:12:39,,59400,226,0,59400,1,1,1,100959420321117022511123900313,,20170225111239392730,4002332001201702251238349863,2017-02-25,oGRo8xM_-MoGpvoFUaGxYDL7xAEQ,0,,
889791002090051,10062836,2017-01-20 23:47:39,2017-01-20 23:47:40,200,0,100,-100,1,3,5,100628360422017012023473900783,100628360821317012023464500641,20170120234645280284879900547971,,2017-01-20,oicgAxAAxPV5aLT4-huFJmg18C7k,0,,
879100314000032,10087034,2017-01-30 18:18:12,2017-01-30 18:18:15,22800,0,7600,-7600,2,1,5,100870340222017013018181200235,100870340722117013017542500903,20170130175425211046308485517826,,2017-01-30,186****6604,0,,
889791002090051,10062836,2017-01-20 23:46:45,,200,1,0,200,1,3,1,100628360821317012023464500641,,20170120234645280284879900547971,4006842001201701207024473500,2017-01-20,oicgAxAAxPV5aLT4-huFJmg18C7k,0,,
879100314000032,10087034,2017-01-30 17:54:27,,22800,137,0,22800,2,1,1,100870340722117013017542500903,,20170130175425211046308485517826,2017013021001004240266576009,2017-01-30,186****6604,0,,
889521000920001,10057111,2017-01-02 09:28:10,,79800,0,0,79800,3,1,1,020926208614,,100096,,2017-01-02,,0,,
请求结果中,每一行表示一条交易记录,记录中各参数以,号分隔。各参数含义如下所示:
商户号,终端号,交易时间,退款完成时间,交易金额(分),手续费金额(分),退款金额(分),结余金额(分),交易类型,支付方式,交易状态,交易单号,退款原单号,终端流水号,渠道订单号,清算日期,用户标识,银行卡类型,附加数据,
参数解释:
| 参数名称 | 说明 |
|---|---|
| 交易类型 | 1 微信 2支付宝 3银行卡 4 现金 5无卡支付 6qq钱包 7百度钱包8京东钱包 |
| 支付方式 | 刷卡支付1,扫码支付2,公众号支付3,wap支付4 |
| 交易状态 | 支付成功1, 退款成功5 |
| 手续费 | 支付成功为正值 退款为负值 |
| 结余金额 | 用作统计,支付成功为支付金额,退款为退款金额负值 |
| 银行卡类型 | 0储蓄卡,1信用卡 |
签名算法
MD5加密,utf-8格式转小写,加密后得到key_sign的值
String key_sign = MD5.encode(day=xxxxxx&inst_no=xxxxxx&key=xxxxxx);
签名参数:
| 参数名称 | 说明 |
|---|---|
| day | 日期,yyyyMMdd,例如:20170208 |
| inst_no | 机构号 |
| key | 机构号对应的令牌 |
注意:
- 当前只能获取上一天的对账单,每天9点对上一天的对账单文件进行生成和上传;
- 目前只允许以机构为单位的对账单下载,商户对帐尚未支持;
- 有对账单下载需求的机构,请先联系利楚商务,提前进行配置。
1.13. 微信参数配置
- URL:/merchant/200/wechatConfigSet
- Method:POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 10 | N | 版本号,扫呗分配(201版本返回参数新增支付appid,关注appid,支付授权目录配置状态) |
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_no | String | 15 | Y | 扫呗商户号 |
| sub_appid | String | 18 | N | 子商户支付APPID(支付、关注APPID和支付授权目录至少传一个) |
| subscribe_appid | String | 18 | N | 子商户推荐关注公众账号APPID(支付、关注APPID和支付授权目录至少传一个) |
| jsapi_path | String | 255 | N | 子商户公众账号JSAPI支付授权目录(支付、关注APPID和支付授权目录至少传一个) |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“签名失败”,“商户名已存在"等 |
| trace_no | String | 32 | Y | 原请求流水号 |
| result_code | String | 2 | Y | 业务结果:“01”成功 ,02”失败 |
以下字段在result_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| merchant_no | String | 15 | N | 扫呗商户号 |
| jsapi_code | String | 2 | N | 支付授权目录配置结果:“01”成功 ,02”失败 |
| jsapi_msg | String | 255 | N | 子商户公众账号JS API支付授权目录响应描述 |
| sub_appid_code | String | 2 | N | 支付appid配置结果:“01”成功 ,02”失败 |
| sub_appid_msg | String | 255 | N | 子商户支付APPID响应描述 |
| subscribe_appid_code | String | 2 | N | 关注appid配置结果:“01”成功 ,02”失败 |
| subscribe_appid_msg | String | 255 | N | 子商户推荐关注公众账号APPID响应描述 |
| key_sign | String | 32 | N | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
1.14. 微信参数配置查询
- URL:/merchant/200/wechatConfigGet
- Method:POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_no | String | 15 | Y | 扫呗商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“签名失败”,“商户名已存在"等 |
| trace_no | String | 32 | Y | 原请求流水号 |
| result_code | String | 2 | Y | 业务结果:“01”成功 ,02”失败 |
以下字段在result_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| merchant_no | String | 15 | N | 扫呗商户号 |
| appid_configlist | String | 255 | N | 支付APPID和关注APPID,Json格式 |
| jsapi_path_list | String | 255 | N | 支付授权目录列表 |
以下为返回参数appid_configlist的内容说明
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| subappid | String | 18 | N | 子商户支付APPID |
| subscribeappid | String | 18 | N | 子商户推荐关注公众账号APPID |
1.15. 商户费率查询接口
- URL:
/merchant/200/queryrate - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_no | String | 15 | Y | 扫呗商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“查询成功”,“请求受限”等 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在result_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果:“01”修改成功 ,02”修改失败 |
| merchant_no | String | 15 | N | 商户号 |
| wx_rate_code | String | 10 | N | 商户当前通道微信费率 |
| ali_rate_code | String | 10 | N | 商户当前通道支付宝费率 |
| qq_rate_code | String | 10 | N | 商户当前通道QQ费率 |
| jd_rate_code | String | 10 | N | 商户当前通道京东费率 |
| key_sign | String | 32 | N | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
1.16. 商户子商户信息查询接口
- URL:
/merchant/200/queryChnlMchntGet - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,扫呗分配 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| merchant_no | String | 15 | Y | 扫呗商户号 |
| key_sign | String | 32 | Y | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码:01成功 ,02失败,请求成功不代表业务处理成功 |
| return_msg | String | 128 | Y | 返回信息提示,“查询成功”,“请求受限”等 |
| result_code | String | 2 | Y | 业务结果:“01”查询成功 ,02”查询失败 |
| trace_no | String | 32 | Y | 请求流水号 |
以下字段在return_code为01时返回
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| sub_mch_info | String | 2048 | N | 商户子商户信息 |
| key_sign | String | 32 | N | 签名检验串,拼装所有非空参数+令牌,32位md5加密转换 |
商户子商户信息:sub_mch_info
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| merchantno_fuiou | String | 32 | N | 富友商户号 |
| wx_sub_mch_id | String | 32 | N | 微信子商户号 |
| ali_sub_mch_id | String | 32 | N | 支付宝商户号 |
2. 商户变更接口
2.1. 商户费率修改接口
- URL:
/merchant/open/updatepayrate - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| notify_url | String | 255 | N | 审核回调地址 |
| rate_list | String | 1024 | N | 费率变更内容集 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| apply_status | String | 2 | N | 申请结果 2提交成功已生效 |
| modify_no | String | 25 | N | 变更单号 |
| key_sign | String | 32 | N | 签名 |
费率变更内容集:rate_list参数详情:
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| type | String | 2 | Y | 费率类型:1 微信 、 2支付宝、 3QQ钱包、 4京东钱包 |
| rate_code | String | 10 | Y | 支付费率code |
2.2. 商户费率查询接口
- URL:
/merchant/open/querypayrate - Method:
POST - 人工审核
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| modify_no | String | 25 | N | 变更单号,不传默认查询当前生效信息 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| modify_no | String | 25 | N | 变更单号 |
| rate_list | String | 1024 | N | 费率变更内容集 |
| key_sign | String | 32 | N | 签名 |
费率变更内容集:rate_list参数详情:
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| type | String | 2 | Y | 费率类型:1 微信 、 2支付宝、 3QQ钱包、 4京东钱包 |
| rate_code | String | 10 | Y | 支付费率code |
| rate_status | String | 2 | Y | 状态:1已生效 2待生效中【次日生效】 3审核中 4已驳回 |
2.3. 结算卡变更接口
- URL:
merchant/open/updatebankcardinfo - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 8 | Y | 机构号 |
| version | String | 4 | Y | 版本号,固定"200" |
| trace_no | String | 11 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| notify_url | String | 125 | Y | 审核结果通知回调地址 |
| bankinfo | JSONString | - | Y | 银行卡信息 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
银行卡信息:bankinfo参数详情
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| merchant_id_no | String | 30 | Y | 结算人身份证号码,对私结算必传 |
| merchant_id_expire | String | 8 | Y | 结算人身份证有效期,格式YYYYMMDD,长期填写29991231 |
| merchant_id_type | String | 2 | Y | 证件类型,默认0身份证 |
| account_name | String | 100 | Y | 入账银行卡开户名(结算人姓名/公司名) |
| account_no | String | 25 | Y | 入账银行卡卡号 |
| account_phone | String | 11 | N | 入账银行预留手机号 |
| bank_name | String | 50 | Y | 入账银行卡开户支行 |
| bank_no | String | 25 | Y | 开户支行联行号(由平台技术支持提供表格) |
| img_private_idcard_a | String | 255 | N | 对私账户身份证正面照片 |
| img_private_idcard_b | String | 255 | N | 对私账户身份证反面照片 |
| img_bankcard_a | String | 255 | N | 入账银行卡正面照片,对私结算必传 |
| img_bankcard_b | String | 255 | N | 入账银行卡反面照片,对私结算必传 |
| company_account_name | String | 100 | N | 对公户结算账户开户名,企业对私必传 |
| company_account_no | String | 25 | N | 对公户结算账户开户号,企业对私必传 |
| company_bank_name | String | 25 | N | 对公户结算账户开户支行,企业对私必传 |
| company_bank_no | String | 25 | N | 对公户结算账户开户支行联行号,企业对私必传(由平台技术支持提供表格) |
| img_open_permits | String | 255 | N | 开户许可证照片,对公结算必传 |
| img_unincorporated | String | 255 | N | 入账非法人授权函证明照片,非法人结算时必传 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 10 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| apply_status | String | 10 | N | 申请结果 1提交成功,在审核中 |
| modify_no | String | 32 | N | 变更单号 |
| key_sign | String | 32 | N | 签名 |
2.4. 结算卡信息查询接口
- URL:
merchant/open/querybankcardinfo - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 8 | Y | 机构号 |
| version | String | 4 | Y | 版本号,固定"200" |
| trace_no | String | 11 | Y | 请求流水号 |
| merchant_no | String | 15 | Y | 商户号 |
| modify_no | String | 32 | N | 变更单号,传变更单号即查询当前变更单的状态 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 10 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| apply_status | String | 10 | N | 申请结果 1提交成功,在审核中 2:审核通过 3:审核驳回 |
| bankinfo | JSONString | - | N | 银行卡信息 |
| key_sign | String | 32 | N | 签名 |
银行卡信息bankinfo参数详情:
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| account_type | String | 2 | N | 账户类型,1对公,2对私 |
| settlement_type | String | 2 | N | 结算类型:1.法人结算 2.非法人结算 |
| merchant_id_no | String | 30 | N | 结算人身份证号码 |
| merchant_id_expire | String | 8 | N | 结算人身份证有效期,格式YYYYMMDD,长期填写29991231 |
| merchant_id_type | String | 2 | N | 证件类型,默认0身份证 |
| account_name | String | 100 | N | 入账银行卡开户名(结算人姓名/公司名) |
| account_no | String | 25 | N | 入账银行卡卡号 |
| account_phone | String | 11 | N | 入账银行预留手机号 |
| bank_name | String | 50 | N | 入账银行卡开户支行 |
| bank_no | String | 25 | N | 开户支行联行号(由平台技术支持提供表格) |
| img_private_idcard_a | String | 255 | N | 对私账户身份证正面照片 |
| img_private_idcard_b | String | 255 | N | 对私账户身份证反面照片 |
| img_bankcard_a | String | 255 | N | 入账银行卡正面照片 |
| img_bankcard_b | String | 255 | N | 入账银行卡反面照片 |
| company_account_name | String | 100 | N | 对公户结算账户开户名 |
| company_account_no | String | 25 | N | 对公户结算账户开户号 |
| company_bank_name | String | 25 | N | 对公户结算账户开户支行 |
| company_bank_no | String | 25 | N | 对公户结算账户开户支行联行号(由平台技术支持提供表格) |
| img_open_permits | String | 255 | N | 开户许可证照片 |
| img_unincorporated | String | 255 | N | 入账非法人授权函证明照片 |
2.5. 商户结算周期变更接口
- URL:
/merchant/open/updatesettletype - Method:
POST - 免审
- 到账T+1 :settle_type="1""且daily_timely_status="0"
- 到账D+1 :settle_type="1"且daily_timely_status="1"
- 手动清算 :settle_type="2"
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| notify_url | String | 255 | N | 审核回调地址,预留 |
| settle_type | String | 2 | Y | 清算类型:1自动结算;2手动结算; |
| daily_timely_status | String | 2 | O | D1开通状态,0不开通,1开通,settle_type="1"时必传 |
| daily_timely_code | String | 6 | O | 即时到账或者非工作日结算费率;daily_timely_status="1"时必填 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| apply_status | String | 2 | N | 申请结果 1生效 、2审核中 、3驳回 |
| modify_no | String | 25 | N | 变更单号 |
| key_sign | String | 32 | N | 签名 |
2.6. 商户结算周期变更查询接口
- URL:
/merchant/open/querysettletype - Method:
POST - 人工审核
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| modify_no | String | 25 | N | 变更单号,不传默认查询当前生效信息 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| modify_no | String | 25 | N | 变更单号 |
| apply_status | String | 2 | N | 申请结果 申请结果 1生效 、2审核中 、3驳回 |
| settle_type | String | 2 | Y | 清算类型:1自动结算;2手动结算; |
| daily_timely_status | String | 2 | O | D1开通状态,0不开通,1开通,不传默认开通 |
| daily_timely_code | String | 6 | O | 即时到账或者非工作日结算费率;daily_timely_status="1"时必填 |
| key_sign | String | 32 | N | 签名 |
2.7. 即时到账(D0)业务申请接口
- URL:
/merchant/open/timelystatus_open - Method:
POST - 人工审核
变更记录
| 时间 | 操作人 | 字段名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|---|---|
| 2020-04-15 | HLP | zero_arr_type | String | 2 | Y | 请求参数新增D0业务类型字段"zero_arr_type" |
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| apply_type | String | 8 | Y | 状态:1申请开通 2关闭 |
| zero_arr_type | String | 2 | Y | D0类型:1普通纯D0(通过D0提现接口,只可提未结算资金,即时到账)2:钱包D0(默认手动清算模式,通过D0提现接口,可提全部资金,灵活到账周期) |
| timely_code | String | 20 | O | D0手续费代码,取值范围见D0费率表,apply_type="1"时传入; |
| account_phone | String | 13 | O | 银行卡预留手机号,apply_type="1"时选填,入网已提供正确,可不必再填写; |
| notify_url | String | 255 | N | 审核回调地址 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
钱包D0 timely_code
| 费率code | 说明 |
|---|---|
| Q010010 | 1‰,1元保底 ,(推荐) |
| Q001010 | 0.1‰,1元保底 |
| Q010005 | 1‰,0.5元保底 |
| Q005010 | 0.5‰,1元保底 |
| Q005005 | 0.5‰,0.5元保底 |
| Q003010 | 0.3‰,1元保底 |
| Q003005 | 0.3‰,0.5元保底 |
普通D0 timely_code
| 费率code | 说明 |
|---|---|
| T001010 | 0.1‰,1元保底 |
| T001020 | 0.1‰,2元保底 |
| T002010 | 0.2‰,1元保底 |
| T002020 | 0.2‰,2元保底 |
| T003005 | 0.3‰,0.5元保底 |
| T003010 | 0.3‰,1元保底 |
| T003020 | 0.3‰,2元保底 |
| T004010 | 0.4‰,1元保底 |
| T004020 | 0.4‰,2元保底 |
| T004030 | 0.4‰,3元保底 |
| T004050 | 0.4‰;5元保底 |
| T005010 | 0.5‰,1元保底 |
| T005020 | 0.5‰,2元保底 |
| T005030 | 0.5‰,3元保底 |
| T006010 | 0.6‰,1元保底 |
| T006020 | 0.6‰,2元保底 |
| T007010 | 0.7‰,1元保底 |
| T007020 | 0.7‰,2元保底 |
| T008010 | 0.8‰,1元保底 |
| T008020 | 0.8‰,2元保底 |
| T009010 | 0.9‰,1元保底 |
| T009020 | 0.9‰,2元保底 |
| T010010 | 1.0‰,1元保底 |
| T010020 | 1.0‰,2元保底 |
| T011010 | 1.1‰,1元保底 |
| T011020 | 1.1‰,2元保底 |
| T012010 | 1.2‰,1元保底 |
| T012020 | 1.2‰,2元保底 |
| T013010 | 1.3‰,1元保底 |
| T013020 | 1.3‰,2元保底 |
| T014010 | 1.4‰,1元保底 |
| T014020 | 1.4‰,2元保底 |
| T015010 | 1.5‰;1元保底 |
| T015020 | 1.5‰;2元保底 |
| T016010 | 1.6‰,1元保底 |
| T016020 | 1.6‰,2元保底 |
| T017010 | 1.7‰,1元保底 |
| T017020 | 1.7‰,2元保底 |
| T018010 | 1.8‰,1元保底 |
| T018020 | 1.8‰,2元保底 |
| T019010 | 1.9‰,1元保底 |
| T019020 | 1.9‰,2元保底 |
| T020010 | 2.0‰,1元保底 |
| T020020 | 2.0‰,2元保底 |
| T021010 | 2.1‰,1元保底 |
| T021020 | 2.1‰,2元保底 |
| T022010 | 2.2‰,1元保底 |
| T022020 | 2.2‰,2元保底 |
| T023010 | 2.3‰,1元保底 |
| T023020 | 2.3‰,2元保底 |
| T024010 | 2.4‰,1元保底 |
| T024020 | 2.4‰,2元保底 |
| T025010 | 2.5‰,1元保底 |
| T025020 | 2.5‰,2元保底 |
| T026010 | 2.6‰,1元保底 |
| T026020 | 2.6‰,2元保底 |
| T027010 | 2.7‰,1元保底 |
| T027020 | 2.7‰,2元保底 |
| T028010 | 2.8‰,1元保底 |
| T028020 | 2.8‰,2元保底 |
| T029010 | 2.9‰,1元保底 |
| T029020 | 2.9‰,2元保底 |
| T030010 | 3.0‰,1元保底 |
| T030020 | 3.0‰,2元保底 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| apply_status | String | 2 | N | 申请结果: 申请结果 1生效 、2审核中 、3驳回 |
| modify_no | String | 25 | N | 变更单号 |
| key_sign | String | 32 | N | 签名 |
2.8. 即时到账(D0)业务状态查询
- URL:
/merchant/open/timelystatus_query - Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| version | String | 11 | Y | 版本号,固定"200" |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| zero_arr_type | String | 2 | Y | D0类型:1普通纯D0 2:钱包D0 |
| modify_no | String | 25 | N | 变更单号,不传默认查询当前生效信息 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码,01成功、02失败 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号 |
| apply_status | String | 2 | N | d0状态 申请结果 1开通状态 、2关闭状态 、3审核中 、4驳回 、 5禁用 |
| bank_name | String | 32 | N | 开户支行名称 |
| account_no | String | 25 | N | 开户号 |
| account_phone | String | 13 | N | 结算卡预留手机号码 |
| timely_code | String | 20 | N | D0手续费代码,取值范围见D0费率表 |
| modify_no | String | 25 | N | 变更单号 |
| key_sign | String | 32 | N | 签名 |
2.9. 商户回调通知
- Method:
POST
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 15 | Y | 机构编号,平台分配 |
| merchant_no | String | 15 | Y | 商户号 |
| trace_no | String | 32 | Y | 请求流水号,不带“-”的uuid |
| modify_no | String | 25 | N | 变更单号 |
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| business_type | String | 2 | Y | 业务类型:1支付费率变更 2结算信息变更审核 3do变更 4清算类型变更 |
| result_code | String | 2 | Y | 业务处理响应码,状态:01审核通过 02已驳回 |
| key_sign | String | 32 | Y | 传参字典序后,拼接令牌(key)再MD5加密 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码,01成功、02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |