- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
发起进件
接口说明
- 提交商户资料,开通商户号以收款或接收分账。
- 如果进件接口没有返回 merchant_id,请使用原参数重新进件。
使用限制
接入前,请先查看接入前准备是否完成
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/apps/ecpay/v3/saas/create_merchant/ |
HTTP Method | POST |
Scope | trade_basic.developer.create_merchant |
权限要求 | 接口进件 |
请求头
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
access-token | String | 是 | 当非服务商时,调用https://open.douyin.com/oauth/client_token/生成的token 当服务商时,调用https://open.douyin.com/openapi/v2/auth/tp/token/生成的token | |
content-type | String | 是 | 固定值"application/json" |
请求参数
Body
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
business_license | Struct | 是 | 经营地址 | |
channels | List | 是 | 开通支付宝和抖音支付:[ "alipay" , "hz"] 开通支付宝、抖音支付、微信:[ "wx" , "alipay" , "hz"] | 进件渠道 枚举值:
|
city_code | String | 是 | 110100 | 注册的市编码,获取链接 |
create_name | String | 是 | 张三 | 张三 |
district_code | String | 是 | 110107 | 注册的区编码,获取链接 |
industry_code | List | 是 | ["1520"] | 行业类型code,获取链接 |
legal_person | Struct | 是 | 法人信息 | |
merchant_card_info | Struct | 是 | 结算账户信息信息 | |
merchant_name | String | 是 | 北京字节跳动有限公司 | 商户名称 和营业执照/身份证上的一致 |
merchant_operation_info | Struct | 是 | 商户管理员信息 | |
merchant_short_name | String | 是 | 字节跳动 | 商户简称 |
merchant_type | Int64 | 是 | 2 | 商户类型枚举值: 1: 个人 2: 企业 3: 个体工商户 4: 小微商户 5: 事业单位 6: 民办非企业组织 7: 社会团体 8: 党政及国家机关 |
out_order_id | String | 是 | s90219201291021920121212 | 外部单号,必须保证唯一,用来标识本次进件请求 |
province_code | String | 是 | 110000 | 注册的省编码 ,获取链接 |
registered_addr | String | 是 | 北京市海淀区xxx | 注册详细地址 |
type | Int64 | 是 | 1 | 进件类型枚举值: 1: 开发者给小程序收款商户进件 2: 开发者给小程序合作方进件 3: 服务商为自己进件 4: 服务商给小程序收款商户进件 5: 服务商给小程序的合作方进件 注意:2、3、5类型的商户号只能接收分账,没有收款权限 |
app_id | String | 否 | tt07e3715e98c9aac0 | 小程序的 app_id 在给小程序或小程序合作方进件必填 |
beneficiary | Struct | 否 | 受益人信息 当所选渠道包含微信,商户类型merchant_type=2为企业,且受益人类型beneficiary_type不是法人时必填,参照下面beneficiary参数描述 | |
beneficiary_type | String | 否 | LEGAL | 受益人类型枚举: LEGAL: 法人 BENEFICIARY: 其他受益人 当所选渠道包含微信、商户类型merchant_type=2为企业时,必填 |
callback_url | String | 否 | 进件结果通知接口(开发者自己的https服务);如果不传默认用支付设置中的回调地址(路径:小程序开发者平台-功能管理-支付-支付产品-支付设置- URL) | |
ext_evidences | List | 否 | 补充材料图片 | |
industry_info_pic_urls | List | 否 | [{"channel":"hz","url":"1.jpeg"}] | 1.特殊行业需要额外补充对应材料,具体如下:特殊行业补充材料说明 2.最多可上传 5 张图片,图片仅支持 BMP、JPG、JPEG、PNG 格式,大小不超过 2MB 3.图片信息列表,详见下面 图片信息参数 |
sub_merchant_id | String | 否 | 商户id,用于接入方自行标识并管理进件方,需要保证在app_id下唯一 type=3时不需传,其他情况必填 | |
thirdparty_id | String | 否 | 小程序第三方平台应用 id 在服务商身份下必填 |
请求示例
curl --location --request POST '/api/apps/ecpay/v3/saas/create_merchant/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{
"app_id": "ttappid1231231",
"thirdparty_id": "",
"sub_merchant_id": "ttsubmerchantid1231",
"type": 1,
"callback_url": "",
"channels": [
"hz",
"alipay",
"wx"
],
"merchant_type": 2,
"merchant_name": "测试商户名称",
"merchant_short_name": "测试",
"province_code": "110000",
"city_code": "110100",
"district_code": "110105",
"registered_addr": "京市海淀区xxxx",
"business_license": {
"business_license_type": 3,
"business_license_code": "1231123112",
"business_license_picurl": [
{
"channel": "hz",
"url": "asdasda1212.jepg"
},
{
"channel": "wx",
"url": "tos-cn-i-01omznotxb/asdasda"
},
{
"channel": "alipay",
"url": "tos-cn-i-01omznotxb/asdaasd"
}
],
"begin_date": "20210917",
"end_date": "20510916"
},
"legal_person": {
"id_type": 1,
"id_no": "123121",
"name": "测试",
"front_pic_url": [
{
"channel": "hz",
"url": "tos-cn-i-01omznotxb/12312"
},
{
"channel": "wx",
"url": "tos-cn-i-01omznotxb/1231"
},
{
"channel": "alipay",
"url": "tos-cn-i-01omznotxb/1231"
}
],
"back_pic_url": [
{
"channel": "hz",
"url": "tos-cn-i-01omznotxb/1231"
},
{
"channel": "wx",
"url": "tos-cn-i-01omznotxb/1231"
},
{
"channel": "alipay",
"url": "tos-cn-i-01omznotxb/1231"
}
],
"begin_date": "20220201",
"exp_date": "20400527",
"address": "122344"
},
"merchant_card_info": {
"account_name": "测试accountname",
"account_no": "123211",
"bank_full_name": "测试银行",
"settle_type": 2,
"card_type": "DC",
"alipay_settle_type": 1,
"alipay_account_no": ""
},
"merchant_operation_info": {
"manage_name": "测试",
"manage_mobile": "183xxxx1211",
"manage_person_type": 1,
"manage_id_no": "12312231231",
"manage_email": "ceshi@qq.com",
"shop_name": "测试小店",
"shop_url": "https://microapp.bytedance.com",
"id_type": 0,
"id_begin_date": "",
"id_exp_date": "",
"id_front_pic_url": "",
"id_back_pic_url": "",
"business_authorization_letter": "",
"alipay_account_no": "123112"
},
"industry_code": [
"7011"
],
"out_order_id": "123121131",
"create_name": "12312312312312",
"beneficiary_type": "LEGAL"
}
'
响应参数
Body
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
err_msg | String | 是 | success | 错误提示信息 |
err_no | Int32 | 是 | 0 | 状态码 0 代表业务处理成功,具体错误码参见后文错误码章节 |
log_id | String | 是 | 抖音开平统一日志id | |
data | Struct | 否 | 返回数据信息 |
响应示例
正常响应示例
{
"err_no": 0,
"err_msg": "成功",
"log_id": "1231231",
"data": {
"apply_id": "SMA202202212156514",
"merchant_id": "M70372492201318182840"
}
}
异常响应示例
{
"err_no": 28001008,
"err_msg": "access_token过期,请刷新或重新授权",
"log_id": "202310061616226C30B180133AE61392D7"
}
错误码
http状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 0 | 受理成功 | 受理成功 |
200 | 1000 | 内部错误 | 系统异常,请使用相同参数稍后重试 |
200 | 1004 | 未知异常 | 请原参数重试 |
200 | 1005 | 频率控制 | 请降低调用频率 |
200 | 1007 | 参数错误:channels参数不合法,请检查 | channels传参说明:
开通支付宝和抖音支付:[ "alipay" , "hz"]
开通支付宝、抖音支付、微信:[ "wx" , "alipay" , "hz"] |
200 | 2008 | token校验异常,请校验请求头中生成token的小程序appid/服务商id和请求参数是否一致 | 请校验请求头中生成token的小程序appid/服务商id和请求参数是否一致 |
200 | 2010 | 参数错误: 参数MerchantType不正确 | 请使用正确的参数重新调用 |
200 | 7001 | 存在流程进行中的申请单或者已经进件成功 | 可通过查询申请单状态查看此申请单的申请状态 |
200 | 7002 | 申请单不存在 | 确认入参,传入正确的申请单编号 |
200 | 7003 | 商户重复入驻 | 商户更换文件后,重新调用 |
200 | 7025 | 当前小程序所归属的服务类目,暂不支持开通支付功能 | 详情请查看 小程序交易能力接入规范 |
200 | 28001008 | access_token过期,请刷新或重新授权 | access_token过期,请根据请求头中token获取方式调用接口重新获取 |