- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
发起进件请求
更新时间 2024-07-24 02:58:49
收藏
我的收藏提交商户资料,开通商户号以收款或接收分账。
使用限制
接口说明
- 1.如果进件接口没有返回 merchant_id,请使用原参数重新进件。
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | POST |
接口频次 | 20QPS(小程序app_id维度或thirdparty_id维度) |
请求头
名称 | 类型 | 必填 | 描述 |
Content-Type | string | 是 | 固定值 "application/json" |
请求参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
app_id | string | 条件选填 | 64 | 小程序的 app_id 在给小程序或小程序合作方进件必填 | tt07e3715e98c9aac0 |
access_token | string | 条件选填 | 64 | 小程序token 在开发者身份下必填 获取链接 | 567234784 |
thirdparty_id | string | 条件选填 | 64 | 小程序第三方平台应用 id 在服务商身份下必填 | ttc4a8b2155b82682f |
component_access_token | string | 条件选填 | 64 | 服务商绑定的token 在进件类型type=3服务商的身份下必填 获取链接 | |
type | number | 是 | - | 进件类型枚举值: 1: 开发者给小程序收款商户进件 2: 开发者给小程序合作方进件 3: 服务商为自己进件 4: 服务商给小程序收款商户进件 5: 服务商给小程序的合作方进件 注意:2、3、5类型的商户号只能接收分账,没有收款权限 | 1 |
sub_merchant_id | string | 条件选填 | 128 | 商户id,用于接入方自行 标识并管理进件方,需要保证在app_id下唯一 type=3时不需传,其他情况必填 | 69560302266147330860 |
callback_url | string | 否 | 256 | 进件结果通知接口(开发者自己的https服务);如果不传默认用支付设置中的回调地址(路径:小程序开发者平台-功能管理-支付-支付产品-支付设置- URL) | |
channels | string[] | 是 | 256 | 进件渠道 枚举值:
|
|
merchant_type | number | 是 | - | 商户类型枚举值: 1: 个人 2: 企业 3: 个体工商户 4: 小微商户 5: 事业单位 6: 民办非企业组织 7: 社会团体 8: 党政及国家机关 | 2 |
merchant_name | string | 是 | 128 | 商户名称 和营业执照/身份证上的一致 | 北京字节跳动有限公司 |
merchant_short_name | string | 是 | 64 | 商户简称 | 字节跳动 |
province_code | string | 是 | 10 | 110000 | |
city_code | string | 是 | 10 | 110100 | |
district_code | string | 是 | 10 | 110107 | |
registered_addr | string | 是 | 256 | 注册详细地址 | 北京市海淀区知春路甲48号2号楼10A室 |
business_license | object | 是 | - | 经营地址,参照下面business_license参数 | 参照示例 |
legal_person | object | 是 | - | 法人信息,参照下面legal_person参数 | 参照示例 |
merchant_card_info | object | 是 | - | 结算账户信息信息,参照下面merchant_card_info参数 | 参照示例 |
merchant_operation_info | object | 是 | - | 商户管理员信息 参照下面merchant_operation_info参数 | 参照示例 |
industry_code | string[] | 是 | 256 | ["1520"] | |
ext_evidences | object[] | 条件选填 | 256 | [{"hz": "1.jpeg","wx":"2.jpeg","alipay":"3.jpeg"}] | |
industry_info_pic_urls | object[] | 条件选填 | 256 | 2.最多可上传 5 张图片,图片仅支持 BMP、JPG、JPEG、PNG 格式,大小不超过 2MB | [{"hz": "1.jpeg","wx":"2.jpeg","alipay":"3.jpeg"}] |
sign | string | 条件选填 | 344 | c639b06f45e74c7b8025acbb45f04bb1 | |
out_order_id | string | 是 | 256 | 外部单号,必须保证唯一,用来标识本次进件请求 | s90219201291021920121212 |
create_name | string | 是 | 64 | 姓名 | 张三 |
beneficiary_type | string | 条件选填 | 20 | 受益人类型枚举: LEGAL: 法人 BENEFICIARY: 其他受益人 当所选渠道包含微信、商户类型merchant_type=2为企业时,必填 | LEGAL |
beneficiary | object | 条件选填 | - | 受益人信息 当所选渠道包含微信,商户类型merchant_type=2为企业,且受益人类型beneficiary_type不是法人时必填,参照下面beneficiary参数描述 | 参照示例 |
business_license 参数
名称 | 类型 | 是否必填 | 最大 长度 | 描述 | 示例值 |
business_license_type | number | 是 | - | 根据商户类型传入对应的证件类型 商户类型-证件类型 对应关系 个人/小微:个人身份证 企业:营业执照(三证合一) 个体工商户:营业执照(三证合一) 事业单位:事业单位法人证书 民办非企业组织:民办非企业登记证书 社会团体:社会团体法人登记证书 党政及国家机关:党政及国家机关资格证 证件类型枚举值 1: 个人身份证 3: 营业执照(三证合一) 4: 民办非企业登记证书 5: 社会团体法人登记证书 6: 事业单位法人证书 7: 党政及国家机关资格证 | 3 |
business_license_code | string | 是 | 128 | 证件号,身份证号/营业执照号 | 410724198302151234 |
business_license_picurl | string | 是 | 256 | {"hz": "1.jpeg","wx":"2.jpeg","alipay":"3.jpeg"} | |
business_license_back_picurl | string | 条件选填 | 256 | {"hz": "1.jpeg","wx":"2.jpeg","alipay":"3.jpeg"} | |
begin_date | string | 是 | 64 | 证件照开始时间, 格式 yyyymmdd | 20211231 |
end_date | string | 是 | 64 | 证件照结束时间, 格式yyyymmdd, 长期填 99991231 | 20221221 |
legal_person 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
id_type | number | 是 | - | 证件类型枚举值 1: 身份证 2: 户口本 3: 护照 4: 军官证 5: 士兵证 6: 香港居民来往内地通行证 7: 台湾同胞来往内地通行证 8: 临时身份 证 9: 外国人居留证 10: 警官证 11: 澳门同胞来往内地通行证 12: 港澳居住证 13: 台湾居住证 100: 其他证件类型(上面没有枚举的) | 1 |
id_no | string | 是 | 20 | 证件号 与id_type对应 | 110000199001011234 |
name | string | 是 | 64 | 证件人名字 | 张三 |
front_pic_url | string | 是 | 256 | {"hz": "1.jpeg","wx":"1.jpeg","alipay":"1.jpeg"} | |
back_pic_url | string | 条件选填 | 256 | {"hz": "2.jpeg","wx":"2.jpeg","alipay":"2.jpeg"} | |
begin_date | string | 是 | 64 | 证件照开始时间yyyymmdd 20211231 | 20211231 |
exp_date | string | 是 | 64 | 证件照过期时间yyyymmdd 20211231 长期填: 99991231 | 20211231 |
address | string | 否 | 256 | 请按照证件上住址填写,若证件上无住址则按照实际住址填写 当所选渠道包含微信、商户类型=2为企业时,需要填写此项 | 浙江省杭州市 |
merchant_card_info 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
account_name | string | 是 | 64 | 卡户名 | 张三 |
account_no | string | 是 | 20 | 银行卡号 | 110909320120601 |
bank_full_name | string | 是 | 128 | 开户支行名 | 招商银行股份有限公司北京支行 |
settle_type | number | 是 | - | 结算类型枚举值: 1: 对私 2: 对公 | 1 |
card_type | string | 是 | - | 银行卡类型枚举值: DC: 借记卡 CC: 信用卡 | DC |
alipay_settle_type | number | 是 | - | 支付宝结算类型枚举值: 1: 卡结算 2: 支付宝账户结算 | 1 |
alipay_account_no | string | 条件选填 | 128 | 支付宝结算账号 alipay_settle_type 参数为2时必传 |
merchant_operation_info 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
manage_name | string | 是 | 128 | 联系人名称 | 李四 |
manage_mobile | string | 是 | 20 | 联系人手机号 | 18688888888 |
manage_person_type | number | 是 | - | 联系人类型枚举值: 1: 法人 2: 非法人 | 1 |
manage_id_no | string | 是 | 20 | 身份证号 | 110000199001011234 |
manage_email | string | 是 | 128 | 联系人邮箱 | |
alipay_account_no | string | 条件选填 | 64 | 支付宝账号 入驻支付宝必填 | |
shop_name | string | 条件选填 | 512 | 店铺名称 入驻支付宝、微信必填 | 字节跳动 |
shop_url | string | 条件选填 | 256 | 店铺链接 入驻支付宝、微信必填 | |
id_type | number | 条件选填 | - | 在manage_person_type为2非法人条件下必填 证件类型枚举值: 1: 身份证 2: 户口本 3: 护照 4: 军官证 5: 士兵证 6: 香港居民来往内地通行证 7: 台湾同胞来往内地通行证 8: 临时身份证 9: 外国人居留证 10: 警官证 11: 澳门同胞来往内地通行证 12: 港澳居住证 13: 台湾居住证 100: 其他证件类型(上面没有枚举的) | 1 |
id_begin_date | string | 条件选填 | 64 | 在manage_person_type为2非法人条件下必填 证件有效期开始时间,格式为yyyyMMdd | 20220617 |
id_exp_date | string | 条件选填 | 64 | 在manage_person_type为2非法人条件下必填 证件有效期过期时间,格式为yyyyMMdd, 长期 99991231 | 20220617 |
id_front_pic_url | string | 条件选填 | 256 | 1.jpg | |
id_back_pic_url | string | 条件选填 | 256 | 1.jpg | |
business_authorization_letter | string | 条件选填 | 256 | 当所选渠道包含微信,且manage_person_type为2非法人的条件下必填 示例 | 1.jpg |
beneficiary 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
id_type | number | 是 | - | 证件类型枚举值 1: 身份证 2: 户口本 3: 护照 4: 军官证 5: 士兵证 6: 香港居民来往内地通行证 7: 台湾同胞来往内地通行证 8: 临时身份证 9: 外国人居留证 10: 警官证 11: 澳门同胞来往内地通行证 12: 港澳居住证 13: 台湾居住证 100: 其他证件类型(上面没有枚举的) | 1 |
id_no | string | 是 | 20 | 证件号 与id_type对应 | 110000199001011234 |
name | string | 是 | 64 | 证件人名字 | 张三 |
front_pic_url | string | 是 | 256 | "1.jpeg" | |
back_pic_url | string | 条件选填 | 256 | "2.jpeg" | |
begin_date | string | 是 | 64 | 证件照开始时间yyyymmdd 20211231 | 20211231 |
exp_date | string | 是 | 64 | 证件照过期时间yyyymmdd 20211231 长期填: 99991231 | 20211231 |
address | string | 条件选填 | 256 | 1.当所选渠道包含微信、商户类型为企业时,需要填写此项 2.请按照证件上住址填写,若证件上无住址则按照实际住址填写 | 浙江省杭州市 |
请求示例
json复制{
"app_id": "app_id123112121",
"access_token": "abc123czxhc84392s123ahdbz9213cdnzujncjznuqh12389834bhdb8bchzj8182jdsjaju123",
"thirdparty_id": "",
"component_access_token": "",
"sub_merchant_id": "test_receive_92",
"type": 2,
"callback_url": "https://www.bytedance.com/cn",
"channels": [
"alipay",
"hz"
],
"merchant_type": 2,
"merchant_name": "北京字节跳动有限公司",
"merchant_short_name": "字节跳动",
"province_code": "110000",
"city_code": "110100",
"district_code": "110107",
"registered_addr": "北京市海淀区北三环西路43号2号楼三层303室",
"business_license": {
"business_license_type": 3,
"business_license_code": "130429199205274617",
"business_license_picurl": {
"hz": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d11",
"alipay": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d23"
},
"begin_date": "20211231",
"end_date": "99991231",
"address": "浙江省杭州市"
},
"legal_person": {
"id_type": 1,
"id_no": "13213429731104601X",
"name": "张三",
"front_pic_url": {
"hz": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d11",
"alipay": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d23"
},
"back_pic_url": {
"hz": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d11",
"alipay": "tos-cn-i-01omznotxb/565352443d7c44b79aa135583ad64d23"
},
"begin_date": "20211231",
"exp_date": "99991231",
"address": "北京市海淀区北三环西路43号2号楼三层303室"
},
"merchant_card_info": {
"account_name": "北京字节跳动有限公司",
"account_no": "110932121411301",
"bank_full_name": "招商银行股份有限公司北京首体支行",
"settle_type": 2,
"card_type": "DC",
"settlement_cert_pic": "tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c",
"relation_cert_pic": "tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c",
"other_cert_pics": [
"tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c",
"tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c"
]
},
"merchant_operation_info": {
"manage_name": "张三",
"manage_mobile": "18388888888",
"manage_person_type": 2,
"manage_id_no": "110101199003078531",
"manage_email": "bytedance@163.com",
"shop_name": "字节跳动",
"shop_url": "http://www.bytedance.com",
"id_type": 1,
"id_begin_date": "20211231",
"id_exp_date": "99991231",
"id_front_pic_url": "tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c",
"id_back_pic_url": "tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c",
"business_authorization_letter": "tos-cn-i-01omznotxb/1e19e6ba8b1e4755a886ab6a7447496c"
},
"industry_code": [
"1520"
],
"sign": "5ee5474aff4e5623f464fd6bf12322bf",
"out_order_id": "s90219201291021920121212x-02",
"create_name": "李四",
"beneficiary_type": "LEGAL"
}
响应参数
公共响应参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
error_no | number | 是 | - | 返回码,详见错误码及错误描述 | 2008 |
error_tips | string | 是 | - | 返回码描述,详见错误码及错误描述 | 签名校验异常,请使用正确的签名和 json 传参 |
业务响应参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
apply_id | string | 是 | 64 | 申请单id | SMA202202212153514 |
merchant_id | string | 是 | 64 | 商户号 | M70372492201318182840 |
响应示例
正常响应示例
json复制{
"err_no": 0,
"err_tips": "成功",
"apply_id": "SMA202202212156514",
"merchant_id": "M70372492201318182840"
}
异常响应示 例
json复制{
"err_no": 2008,
"err_tips": "签名校验异常,请使用正确的签名和 json 传参",
"apply_id": "",
"merchant_id": ""
}
错误码
错误码 err_code | 描述 err_tips | 排查建议 |
0 | 受理成功 | 受理成功 |
1000 | 内部错误 | 系统异常,请使用相同参数稍后重试 |
1004 | 未知异常 | 请原参数重试 |
1005 | 频率控制 | 请降低调用频率 |
1007 | 参数错误:channels参数不合法,请检查 | channels传参说明: 开通支付宝和抖音支付:[ "alipay" , "hz"] 开通支付宝、抖音支付、微信:[ "wx" , "alipay" , "hz"] |
2008 | 签名校验异常,请使用正确的签名和 json 传参 | |
2010 | 参数错误: 参数MerchantType不正确 | 请使用正确的参数重新调用 |
参数错误: 进件渠道为空 | ||
参数错误: 未知类型(Invalid Type) | ||
参数错误:maAppID或者sub_merchant_id为空 | ||
参数错误:thirdPartyID为空 | ||
参数错误:thirdPartyID或maAppID或sub_merchant_id为空 | ||
参数错误:thirdPartyID或sub_merchant_id为空 | ||
参数错误: 参数:MerchantName 为空 | ||
参数错误: 参数:MerchantShortName 为空 | ||
参数错误: 没有抖音支付营业执照 | ||
参数错误: 没有微信营业执照 | ||
参数错误: 没有支付宝营业执照 | ||
参数错误: 营业执照有效期起止时间错误 | ||
参数错误: 进件微信、抖音支付或者进件支付宝且支付宝结算类型为银行卡时,开户银行不可为空 | ||
参数错误: 参数:店铺名称 为空 | ||
参数错误: 参数:店铺链接 为空 | ||
参数错误: 参数:签约的支付宝账户 为空 | ||
参数错误: 参数:OutOrderId 为空 | ||
参数错误:当管理员类型为法人时,管理员姓名和身份证号需要和法人的姓名和身份证号一致 | ||
7001 | 存在流程进行中的申请单或者已经进件成功 | |
7002 | 申请单不存在 | 确认入参,传入正确的申请单编号 |
7003 | 商户重复入驻 | 商户更换文件后,重新调用 |
7025 | 当前小程序所归属的服务类目,暂不支持开通支付功能 |
点击纠错