whalet
首页
开放API
  • 收款
  • 鲸卡
  • 收单
首页
开放API
  • 收款
  • 鲸卡
  • 收单
  1. 用户入网(User Onboarding)
  • 接入指南
  • Integration Guidelines
  • 附录
  • Appendix
  • 用户入网(User Onboarding)
    • 用户入网申请(User Onboarding Apply)
      POST
    • 入网结果通知(User Onboarding Result Notification)
      POST
  • 持有人(Card Holder)
    • 持有人申请(Card Holder Apply)
      POST
    • 持有人结果通知(Card Holder Result Notification)
      POST
    • 持有人查询(Card Holder Query)
      POST
    • 持有人银行账户申请(Card Holder Beneficary Apply)
      POST
    • 持有人银行账户结果通知(Card Holder Beneficary Result Notify)
      POST
    • 持有人银行账户查询(Card Holder Beneficary Query)
      POST
  • 开卡(Virtual Account)
    • 外贸收款(B2B)
      • 申请收款卡(Virtual Account Apply for B2B)
      • 获取外贸收款渠道(Channel Banks Query for B2B)
    • 电商收款(B2C)
      • 申请收款卡(Virtual Account Apply for B2C)
      • 获取收款卡平台配置(Platform Query for B2C)
      • 获取开通收款卡持有人(Card Holder Query for B2C)
      • 查询开卡数(Card number Query for B2C)
      • 绑定/添加店铺(Bind/Unbind Shop for B2C)
      • 注销收款卡((Card Cancel for B2C))
      • 查询收款卡详情(Card Detail Query for B2C)
      • 注销收款卡结果通知(Card Cancel Result Notify for B2C)
      • 查询店铺(Shop Query for B2C)
      • 查询收款卡(Card Query for B2C)
      • 绑定/添加店铺结果通知(Shop Bind/Unbind/Add Result Notify for B2C)
      • 申请银行证明信（Bank Letter Apply For B2C）
    • 申请收款卡结果通知(Virtual Account Notify for B2C)
      POST
  • 收款(Collections)
    • 收款到账通知(Collection Received Notify)
      POST
    • 关联外贸订单(Trade Order Bind Apply for B2B)
      POST
    • 关联外贸订单结果通知(Trade Order Bind Notify for B2B)
      POST
  • 订单(Order)
    • 外贸收款(Trade Order)
      • 订单申请(Trade Order Apply for B2B)
      • 订单详情(Trade Order Query Detail for B2B)
      • 分页查询(Trade Order Query List for B2B)
    • 电商收款(Shop Order)
      • 上传订单(Shop Order Upload for B2C)
  • 提现(Payout)
    • 申请提现/付款(Payout Apply)
      POST
    • 确认提现/付款(Payout Confirm)
      POST
    • 申请提现/付款结果通知(Payout Result Notify)
      POST
    • 查询汇率(Rate Inquiry)
      POST
    • 查询受益人银行账户字段信息(Beneficiary Account Fields Query)
      POST
    • 绑定受益人银行账户(Benificiary Account Apply)
      POST
    • 绑定受益人银行账户结果通知(Benificiary Account Result Notify)
      POST
    • 删除受益人银行账户(Benificiary Account Delete)
      POST
    • 查询支持的受益人银行账户国家/地区(Beneficiary Account Country Query)
      POST
  • 支付(Pay)
    • 申请支付(Pay Apply)
    • 确认支付(Pay Confirm)
    • 申请支付结果通知(Pay Result Notify)
  • 钱包(Wallet)
    • 币种余额(Currency Balance)
    • 平台余额(Platform Balance)
  • 交易查询(Trade Query)
    • 收款记录(Collection Query)
    • 提现记录(Withdraw Query)
    • 付款记录(Payment Query)
    • 支付记录(Pay Query)
  • 补充资料(ReMaterials)
    • EDD补充资料通知(Edd Replenish Notify)
    • EDD补充资料查询(Edd Replenish Query)
    • EDD补充资料提交(Edd Replenish Submit)
    • EDD补充资料结果通知(Edd Replenish Result Notify)
    • 交易补充资料通知(Trade Replenish Notify)
    • 交易补充资料提交(Trade Replenish Submit)
    • 交易补充资料结果通知(Trade Replenish Result Notify)
  • Connectivity
    • 连通性验证(connectivity)
    • 连通性验证通知(connectivityNotify)
  • Mock
    • 入账通知Mock(mockPayeeNotify)
  1. 用户入网(User Onboarding)

用户入网申请(User Onboarding Apply)

POST
userRegister
1.
中国大陆企业成员只能是中国大陆；
2.
过期补充资料不能修改实名主体以及成员的证件信息；
3.
升级企业补充资料时，企业成员必须包含升级前的个人。

Request

Body Params application/json
phoneAreaCode
enum<string> 
手机区号
required
示例：86
<= 8 characters
Allowed values:
8685265144
Example:
86
phone
string 
手机号
required
唯一入网手机号
<= 32 characters
email
string 
邮箱
required
唯一入网邮箱
<= 128 characters
referralChannel
string 
推荐代理商
required
注册推荐代理商编号 (Whalet提供)
<= 30 characters
entityType
enum<string> 
主体类型
required
主体类型
<= 16 characters
Allowed values:
PersonEnterprise
countryCode
enum<string> 
主体国别
required
国家ISO 二字码
>= 2 characters<= 2 characters
Allowed values:
CNHK
Example:
CN
entityName
string 
主体中文名
required
>= 1 characters<= 100 characters
entityNameEn
string 
主体英文名
required
>= 1 characters<= 100 characters
firstNameEn
string 
英文名-名
optional
个人必须
<= 50 characters
lastNameEn
string 
英文名-姓
optional
个人必须
<= 50 characters
certificateType
enum<string> 
证件类型
required
个人只能为 身份证，企业可填类型为： 统一社会信用代码、企业注册证书
Allowed values:
Identity_CardUniform_Social_Credit_CodeEnterprise_Registration_Certificate
certificateNumber
string 
证件号
required
<= 64 characters
certificateValidityBeginDate
string 
证件有效期-开始日期
optional
格式：yyyy-MM-dd， 个人必须
certificateValidityLongTerm
enum<string> 
证件是否长期有效
optional
个人必须
Allowed values:
YN
certificateValidityEndDate
string 
证件有效期-截至日期
optional
格式：yyyy-MM-dd，个人且certificateValidityLongTerm为N时必须
certificateFrontFile
object (StorageFile) 
证件照正面
required
个人为证件照正面，大陆企业为营业执照，香港企业为注册证书
fileId
string 
文件ID
required
<= 32 characters
fileName
string 
文件名
required
<= 255 characters
fileUrl
string 
文件地址
required
<= 255 characters
certificateBackFile
object (StorageFile) 
证件照反面
optional
仅适用于个人主体
holdingCertificateFile
object (StorageFile) 
手持证件照
optional
仅适用于个人主体
birthDate
string 
生日
optional
出生日期，格式：yyyy-MM-dd，仅适用于个人主体
gender
enum<string> 
性别
optional
仅适用于个人主体
Allowed values:
MALEFEMALE
address
object 
地址
required
地址信息（个人证件地址/企业注册地址）
province
string 
省份
required
<= 32 characters
city
string 
城市
required
<= 32 characters
area
string 
区/县
optional
大陆必填
<= 32 characters
street
string 
详细地址
required
<= 256 characters
sameAddressFlag
enum<string> 
required
经营地址是否与注册地址一致（企业）/居住地址是否与证件地址一致（个人）
Allowed values:
YN
resideAddress
object 
居住地址
optional
仅适用于个人主体，sameAddressFlag为N时必填
province
string 
省份
required
<= 32 characters
city
string 
城市
required
<= 32 characters
area
string 
区/县
optional
大陆必填
<= 32 characters
street
string 
详细地址
required
<= 256 characters
businessAddress
object 
企业经营地址
optional
仅适用于企业主体，sameAddressFlag为N时必填
province
string 
省份
required
<= 32 characters
city
string 
城市
required
<= 32 characters
area
string 
区/县
optional
大陆必填
<= 32 characters
street
string 
详细地址
required
<= 256 characters
holdingApplyFile
object (StorageFile) 
手持申请表
optional
仅适用于企业主体
originalApplyFile
object (StorageFile) 
申请表原件
optional
仅适用于企业主体
businessRegistrationCertificateFile
object (StorageFile) 
商业登记证书BR
optional
仅适用于香港企业主体
incorporationFormFile
object (StorageFile) 
法团成立表格NC
optional
仅适用于香港企业主体
annualReturnFile
array[object (StorageFile) {3}] 
周年申请表NAR1
optional
仅适用于香港企业主体
<= 10 items
fileId
string 
文件ID
required
<= 32 characters
fileName
string 
文件名
required
<= 255 characters
fileUrl
string 
文件地址
required
<= 255 characters
enterpriseEstablishBeginDate
string 
企业成立有效期-起始日期
optional
yyyy-MM-dd，仅适用于企业主体
enterpriseEstablishEndDate
string 
企业成立有效期-截至日期
optional
yyyy-MM-dd，仅适用于企业主体，enterpriseEstablishLongTerm为N时必填
enterpriseEstablishLongTerm
enum<string> 
企业成立有效期是否长期有效
optional
企业时必填
Allowed values:
YN
businessGoodsType
array[string]
出口产品
optional
仅适用于企业主体
Allowed values:
ELECTRONICSFOODSCLOTHINGOFFICEBAGSTOYHAIRDRESSINGARTWORKHOMEIRONWAREDAILYFITNESSOTHER
businessCountry
array[string]
销售目的国家地区
optional
国家/地区ISO 二字简码，仅适用于企业主体
businessScale
enum<integer> 
企业规模
optional
仅适用于企业主体
Allowed values:
1234
historyExportAmount
integer 
历史出口额
optional
单位：万美元，仅适用于企业主体
estimateYearExportAmount
integer 
预估年出口额
optional
单位：万美元，仅适用于企业主体
members
array [object {20}] 
重要成员
optional
<= 5 items
name
string 
名
required
<= 64 characters
englishName
string 
英文名
required
<= 100 characters
firstNameEn
string 
英文名-名
required
lastNameEn
string 
英文名-姓
required
birthDate
string 
生日
required
格式yyyy-MM-dd
<= 16 characters
Match pattern:
yyyy-MM-dd
gender
enum<string> 
性别
required
<= 16 characters
Allowed values:
MALEFEMALE
roles
array[string]
身份
required
Allowed values:
Legal_RepresentativeEnterprise_PartnerControl_People
shareholderRatio
number <double>
持股比例
required
1~100 保留两位小数
countryCode
enum<string> 
国家
required
国家ISO 二字码
<= 2 characters
Allowed values:
CNHK
certificateType
enum<string> 
证件类型
required
可填身份证、护照、香港本地身份证
Allowed values:
Identity_CardPassportHK_Id
certificateNumber
string 
证件号码
required
certificateValidityBeginDate
string 
证件有效期-起始日期
required
格式yyyy-MM-dd
Match pattern:
yyyy-MM-dd
certificateValidityLongTerm
enum<string> 
是否长期有效
required
Allowed values:
YN
certificateValidityEndDate
string 
证件有效期-截至日期
optional
格式yyyy-MM-dd，certificateValidityLongTerm为N时必填
Match pattern:
yyyy-MM-dd
certificateFrontFile
object (StorageFile) 
证件照正面
required
certificateBackFile
object (StorageFile) 
证件照反面
optional
身份证必须
holdingCertificateFile
object (StorageFile) 
手持证件照
required
address
object 
地址信息
required
证件地址
sameAddressFlag
enum<string> 
required
居住地址是否与证件地址一致
Allowed values:
YN
resideAddress
object 
optional
居住地址，sameAddressFlag为N时必须
reMaterial
enum<string> 
是否补充资料
required
>= 1 characters<= 1 characters
Allowed values:
YN
Example:
Y
materialType
enum<string> 
补充资料类型
optional
补充资料时必须
Allowed values:
RejectExpiredUpgrade
userId
string 
用户ID
optional
补充资料时必须
<= 30 characters
noticeFlag
enum<string> 
是否消息通知
required
为"Y"时，相关业务会给用户发送消息通知（短信/邮件）
Allowed values:
YN
Example
{
    "phoneAreaCode": "86",
    "phone": "string",
    "email": "string",
    "referralChannel": "string",
    "entityType": "Person",
    "countryCode": "CN",
    "entityName": "string",
    "entityNameEn": "string",
    "firstNameEn": "string",
    "lastNameEn": "string",
    "certificateType": "Identity_Card",
    "certificateNumber": "string",
    "certificateValidityBeginDate": "string",
    "certificateValidityLongTerm": "Y",
    "certificateValidityEndDate": "string",
    "certificateFrontFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "certificateBackFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "holdingCertificateFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "birthDate": "string",
    "gender": "MALE",
    "address": {
        "province": "string",
        "city": "string",
        "area": "string",
        "street": "string"
    },
    "sameAddressFlag": "Y",
    "resideAddress": {
        "province": "string",
        "city": "string",
        "area": "string",
        "street": "string"
    },
    "businessAddress": {
        "province": "string",
        "city": "string",
        "area": "string",
        "street": "string"
    },
    "holdingApplyFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "originalApplyFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "businessRegistrationCertificateFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "incorporationFormFile": {
        "fileId": "string",
        "fileName": "string",
        "fileUrl": "string"
    },
    "annualReturnFile": [
        {
            "fileId": "string",
            "fileName": "string",
            "fileUrl": "string"
        }
    ],
    "enterpriseEstablishBeginDate": "string",
    "enterpriseEstablishEndDate": "string",
    "enterpriseEstablishLongTerm": "Y",
    "businessGoodsType": [
        "ELECTRONICS"
    ],
    "businessCountry": [
        "string"
    ],
    "businessScale": 1,
    "historyExportAmount": 0,
    "estimateYearExportAmount": 0,
    "members": [
        {
            "name": "string",
            "englishName": "string",
            "firstNameEn": "string",
            "lastNameEn": "string",
            "birthDate": "string",
            "gender": "MALE",
            "roles": [
                "Legal_Representative"
            ],
            "shareholderRatio": 0,
            "countryCode": "CN",
            "certificateType": "Identity_Card",
            "certificateNumber": "string",
            "certificateValidityBeginDate": "string",
            "certificateValidityLongTerm": "Y",
            "certificateValidityEndDate": "string",
            "certificateFrontFile": {
                "fileId": "string",
                "fileName": "string",
                "fileUrl": "string"
            },
            "certificateBackFile": {
                "fileId": "string",
                "fileName": "string",
                "fileUrl": "string"
            },
            "holdingCertificateFile": {
                "fileId": "string",
                "fileName": "string",
                "fileUrl": "string"
            },
            "address": {
                "province": "string",
                "city": "string",
                "area": "string",
                "street": "string"
            },
            "sameAddressFlag": "Y",
            "resideAddress": {
                "province": "string",
                "city": "string",
                "area": "string",
                "street": "string"
            }
        }
    ],
    "reMaterial": "Y",
    "materialType": "Reject",
    "userId": "string",
    "noticeFlag": "Y"
}

Responses

🟢200成功
application/json
Body
userId
string 
用户ID
required
Example
{
    "userId": "string"
}
Modified at 2025-03-13 01:21:53
Previous
Appendix
Next
入网结果通知(User Onboarding Result Notification)
Built with