PayKKa OpenAPI Documentation
  1. 商户入网
PayKKa OpenAPI Documentation
  • 概述
  • 接口规则
  • SDK
  • 通信安全
    • 签名生成与验证
  • API列表
    • 商户入网
      • 商户入网申请
        POST
      • 商户资料更新
        POST
      • 商户入网结果查询
        POST
      • 商户入网结果(通知)
        POST
    • 收款账户
      • 收款账户开通申请
      • 收款账号开通申请结果查询
      • 收款账号开通结果(通知)
    • 汇入汇款
      • 汇入汇款(通知)
    • 订单
      • 订单创建
      • 订单更新
      • 订单状态查询
      • 补充物流(发货)信息
    • 解付入账
      • 创建解付入账流程
      • 解付入账状态查询
      • 解付入账结果(通知)
    • 账户余额
      • 查询账户余额
    • 收款人
      • 收款人创建
      • 修改收款人(用于被驳回时修改收款人信息)
      • 收款人创建结果查询
      • 收款人创建结果(通知)
    • 换汇
      • 换汇预下单(询价)
      • 换汇确认
      • 查询换汇结果
      • 换汇结果通知
    • 付款
      • 付款
      • 付款状态查询
      • 付款结果通知
    • 文件服务
      • 文件上传接口参数说明
      • 文件上传
  • 附录
    • 开通收款账户码表
    • 商品品类
    • 经营品类
    • 省市编码
    • 银行编码
    • 行业
    • 国家地区代码
  1. 商户入网

商户入网申请

POST
/api/v2/merch/onboard/apply
商户入网v2
创建商户信息

请求参数

Header 参数
X-Merch-Id
string 
可选
默认值:
M24061911365700670
Body 参数application/json
request_id
string 
必需
请求号,请求方系统内唯一
>= 1 字符<= 32 字符
contact_person
object 
联系人信息
必需
phone_prefix
string 
必需
所属国家地区区号, 如:+86 或 +852
>= 0 字符<= 5 字符
phone
string 
必需
联系人电话(长度64字符)
>= 0 字符<= 64 字符
email
string 
必需
联系人邮箱(长度64字符)
>= 0 字符<= 64 字符
license
object 
企业信息
必需
region
string 
必需
2位英文国家编码, 参考附录-国家地区代码
>= 0 字符<= 2 字符
ent_name
string 
必需
企业名称(长度128个字符)
>= 0 字符<= 128 字符
ent_name_en
string 
必需
企业英文名称(长度128个字符)
>= 0 字符<= 128 字符
found_date
string <date>
成立日期
必需
registered_currency
string 
必需
注册资本币种符号, 使用ISO-4217标准3位币种代码
>= 0 字符<= 3 字符
registered_capital
number 
必需
注册资本,币种最小单位。没有注册资金的填0; reigon为大陆企业则是CNY, 为香港企业则是HKD, 为全球企业则是USD
address
object 
企业注册地址信息
必需
legal_rep_name
string 
可选
region为大陆必填-大陆企业 法定代表人姓名
>= 0 字符<= 128 字符
license_file_id
integer <int32>
可选
region为大陆必填-大陆企业 营业执照文件
ent_type
string 
可选
region为大陆必填-企业类型: PERSONAL-个体工商户, OTHER-其它, ENTERPRISE-企业, GOV-政府及事业单位, SOCIAL-社会组织, PN-民办非企业
uni_social_credit
string 
可选
region为大陆必填-大陆企业 统一社会信用代码
>= 0 字符<= 18 字符
busi_from
string <date>
可选
region为大陆必填-大陆企业 经营日期(起)
busi_end
string <date>
可选
region为大陆选填-大陆企业 经营日期(止), 和是否长期互斥必填二选一,都传默认长期
long_term
boolean 
可选
region为大陆选填-是否长期, 和企业经营截止日期互斥,都传默认长期
br_no
string 
可选
region为香港必填-全球企业登记证号码
br_file_id
integer <int32>
可选
region为香港必填-全球企业公司注册证书
annual_return_file_id
integer <int32>
可选
region为香港选填-香港企业 周年申报表(和法团成立表二选一)
incorporation_form_file_id
integer <int32>
可选
region为香港选填-香港企业 法团成立表(和周年申报表二选一)
br_expiry_date
string <date>
可选
region为香港必填-香港企业 届满日期:yyyy-MM-dd
cr_issue_date
string <date>
可选
region为香港必填-香港企业 证明书发出日期:yyyy-MM-dd
company_article_file_id
integer <int32>
可选
region为非大陆选填-公司章程文件
cr_file_id
integer <int32>
可选
region为非大陆必填-香港/全球企业公司注册证书
cr_no
string 
可选
region为非大陆必填-香港企业证明书编号/全球企业登记证号码
share_structure_file_id
integer <int32>
可选
region为非大陆选填-全球企业 股权架构文件
cr_expiry_date
string <date>
可选
region为全球必填-全球企业 届满日期:yyyy-MM-dd
other_file_ids
array[integer <int32>]
其他附件
可选
business
object 
企业经营信息
必需
industry
integer <int32>
必需
行业 数据字典 INDUSTRY(见附录)
employee_number
string 
必需
企业员工人数: FIRST_LEVEL:少于5人、SECOND_LEVEL:5-20人, THIRD_LEVEL:20-50人, FOURTH_LEVEL:50人以上
address
object 
企业经营地址信息
必需
export_country
array[string]
必需
主要出口国家(非制裁国家),数组,使用ISO3166-2标准2位国家/地区代码(见附录)
export_type
array[string]
必需
出口类型:SELF_SUPPORT-自营出口,EXPORT-委托出口,INTERNATIONAL-国际快速,OTHER-其他
trade_volume
string 
必需
月贸易额: FIRST_LEVEL(0-5万美元)、SECOND_LEVEL(5-10万美元)、THIRD_LEVEL(10-25万美元)、FOURTH_LEVEL(25-50万美元)、FIFTH_LEVEL(50-100万美元)、SIXTH_LEVEL(100万美元以上)
website
string 
可选
公司网站(字符长度200)
>= 0 字符<= 200 字符
stakeholder_list
array [object {15}] 
必需
企业关联个人信息列表
identity_type
string 
必需
身份类型: LEGAL_PERSON-法人、BENEFICIARY-最终受益人、SHAREHOLDER-股东、DIRECTOR-董事
name
string 
必需
姓名(长度128字符)
>= 0 字符<= 128 字符
nationality
string 
必需
国籍(ISO3166-2标准2位国家/地区代码)
>= 0 字符<= 2 字符
birth_date
string <date>
必需
生日, 格式yyyy-MM-dd,如 2023-12-12
address_proof_file_id
integer <int32>
可选
地址证明文件, 非中国大陆身份证,地址证明文件必填
doc_type
string 
必需
身份证类型 ID_CARD:二代居民身份证,HK_CARD:香港永久居住证,PASSPORT:护照,MO_CARD:澳门永久居住证,HK_MO_PASS:港澳居民来往内地通行证,TW_CARD:台湾居民来往大陆通行证
id_number
string 
必需
证件号码(长度18字符)
>= 0 字符<= 18 字符
doc_address
string 
可选
证件详细地址(长度256字符), 大陆身份证必填
>= 0 字符<= 256 字符
doc_non_portrait_side_file_id
integer <int32>
可选
证件反面文件, 除护照、台湾往来大陆通行证不需要提供,其他证件类型均需要提供
doc_portrait_side_file_id
integer <int32>
证件正面文件
必需
eff_date_start
string <date>
必需
证件起始日期;格式yyyy-MM-dd,如 2023-12-12
eff_date_end
string <date>
可选
证件失效日期;格式yyyy-MM-dd,如 2023-12-12,和long_term二选一, 其它按日期格式上传
long_term
boolean 
可选
是否长期(大陆身份证件选填), 和eff_date_end二选一
share
number 
可选
持股比例, 百分比, 51.12%传51.12, 最多两位小数, 最终受益人、股东必填
resident_address
object 
居住地址信息
必需
示例
{
    "request_id": "string",
    "contact_person": {
        "phone_prefix": "strin",
        "phone": "string",
        "email": "string"
    },
    "license": {
        "region": "st",
        "ent_name": "string",
        "ent_name_en": "string",
        "found_date": "2019-08-24",
        "registered_currency": "str",
        "registered_capital": 0,
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "legal_rep_name": "string",
        "license_file_id": 0,
        "ent_type": "string",
        "uni_social_credit": "string",
        "busi_from": "2019-08-24",
        "busi_end": "2019-08-24",
        "long_term": true,
        "br_no": "string",
        "br_file_id": 0,
        "annual_return_file_id": 0,
        "incorporation_form_file_id": 0,
        "br_expiry_date": "2019-08-24",
        "cr_issue_date": "2019-08-24",
        "company_article_file_id": 0,
        "cr_file_id": 0,
        "cr_no": "string",
        "share_structure_file_id": 0,
        "cr_expiry_date": "2019-08-24",
        "other_file_ids": [
            0
        ]
    },
    "business": {
        "industry": 0,
        "employee_number": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "export_country": [
            "string"
        ],
        "export_type": [
            "string"
        ],
        "trade_volume": "string",
        "website": "string"
    },
    "stakeholder_list": [
        {
            "identity_type": "string",
            "name": "string",
            "nationality": "st",
            "birth_date": "2019-08-24",
            "address_proof_file_id": 0,
            "doc_type": "string",
            "id_number": "string",
            "doc_address": "string",
            "doc_non_portrait_side_file_id": 0,
            "doc_portrait_side_file_id": 0,
            "eff_date_start": "2019-08-24",
            "eff_date_end": "2019-08-24",
            "long_term": true,
            "share": 0,
            "resident_address": {
                "province": "string",
                "city": "string",
                "zipcode": "string",
                "address1": "string",
                "address2": "string"
            }
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open-fat.cb.paykka.com/api/v2/merch/onboard/apply' \
--header 'X-Merch-Id: M24061911365700670' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "contact_person": {
        "phone_prefix": "strin",
        "phone": "string",
        "email": "string"
    },
    "license": {
        "region": "st",
        "ent_name": "string",
        "ent_name_en": "string",
        "found_date": "2019-08-24",
        "registered_currency": "str",
        "registered_capital": 0,
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "legal_rep_name": "string",
        "license_file_id": 0,
        "ent_type": "string",
        "uni_social_credit": "string",
        "busi_from": "2019-08-24",
        "busi_end": "2019-08-24",
        "long_term": true,
        "br_no": "string",
        "br_file_id": 0,
        "annual_return_file_id": 0,
        "incorporation_form_file_id": 0,
        "br_expiry_date": "2019-08-24",
        "cr_issue_date": "2019-08-24",
        "company_article_file_id": 0,
        "cr_file_id": 0,
        "cr_no": "string",
        "share_structure_file_id": 0,
        "cr_expiry_date": "2019-08-24",
        "other_file_ids": [
            0
        ]
    },
    "business": {
        "industry": 0,
        "employee_number": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "export_country": [
            "string"
        ],
        "export_type": [
            "string"
        ],
        "trade_volume": "string",
        "website": "string"
    },
    "stakeholder_list": [
        {
            "identity_type": "string",
            "name": "string",
            "nationality": "st",
            "birth_date": "2019-08-24",
            "address_proof_file_id": 0,
            "doc_type": "string",
            "id_number": "string",
            "doc_address": "string",
            "doc_non_portrait_side_file_id": 0,
            "doc_portrait_side_file_id": 0,
            "eff_date_start": "2019-08-24",
            "eff_date_end": "2019-08-24",
            "long_term": true,
            "share": 0,
            "resident_address": {
                "province": "string",
                "city": "string",
                "zipcode": "string",
                "address1": "string",
                "address2": "string"
            }
        }
    ]
}'

返回响应

🟢200成功
*/*
OK
Body
authorize_link
string 
授权链接
必需
>= 0 字符<= 256 字符
merch_id
string 
商户id
必需
>= 1 字符<= 20 字符
示例
{
    "authorize_link": "string",
    "merch_id": "string"
}
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🟠429429
🔴500服务器错误
修改于 2025-06-25 08:45:53
上一页
API列表
下一页
商户资料更新
Built with