whalet
首页
开放API
  • 收款
  • 鲸卡
  • 收单
首页
开放API
  • 收款
  • 鲸卡
  • 收单
  1. 持有人(Card Holder)
  • 接入指南
  • 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. 持有人(Card Holder)

持有人查询(Card Holder Query)

POST
userHolderQuery

Request

Body Params application/json
userId
string 
用户ID
required
holderId
string 
持有人ID
optional
status
enum<string> 
状态
optional
Allowed values:
WAITPASSREJECT
pageNum
integer 
当前分页
optional
>= 1
Default:
1
pageSize
integer 
每页数量
optional
>= 1<= 100
Default:
10
Example
{
    "userId": "string",
    "holderId": "string",
    "status": "WAIT",
    "pageNum": 1,
    "pageSize": 10
}

Responses

🟢200成功
application/json
Body
total
integer 
总记录数
required
size
integer 
每页条数
required
current
integer 
当前页数
required
pages
integer 
总页数
required
records
array[object (UserHolder) {33}] 
required
holderId
string 
持有人ID
required
<= 30 characters
userId
string 
用户ID
required
holderType
enum<string> 
持有人类型
required
Allowed values:
EnterprisePerson
holderCountry
string 
持有人国家/地区
required
ISO国家地区二字编码
identityType
enum<string> 
持有人身份类型
required
Allowed values:
EMPLOYEELOCAL_SALES_MANAGERASSOCIATED_COMPANYOPERATING_SALES_COMPANYOTHER
identityTypeMemo
string 
其他持有人身份描述
optional
持有人身份为其他时必须
<= 200 characters
authCertify
array[object (StorageFile) {3}] 
授权证明文件
required
holderCertify
array[object (StorageFile) {3}] 
持有证明文件
required
holderName
string 
持有人中文名称
optional
持有人国家/地区为CN时必须
<= 100 characters
holderNameEn
string 
持有人英文名称
required
<= 100 characters
firstNameEn
string 
持有人英文名-名
optional
个人必须
<= 50 characters
lastNameEn
string 
持有人英文名-姓
optional
个人必须
<= 50 characters
holderStatus
enum<string> 
持有人状态
required
Allowed values:
WAITPASSREJECT
holderCertNo
string 
持有人证件号
required
<= 100 characters
holderCertType
enum<string> 
持有人证件类型
required
大陆企业支持统一社会信用代码；其他地区企业支持企业注册证书；大陆个人支持身份证，美国个人支持护照、驾照号码、美国社会安全号码、个人纳税识别号、美国身份证，其他地区个人仅支持护照。
Allowed values:
Identity_CardPassportUniform_Social_Credit_CodeEnterprise_Registration_CertificateSSNITINDLNAmerica_Id
holderCertFront
object (StorageFile) 
持有人证件文件（正面）
required
holderCertBack
object (StorageFile) 
持有人证件文件（背面）
optional
证件类型为二代身份证时必填
holderAddress
object 
持有人地址
required
个人必须
birthDate
string 
出生日期
optional
出生日期 格式 yyyy-MM-dd 个人必填
Match pattern:
yyyy-MM-dd
gender
enum<string> 
性别
optional
个人必须
Allowed values:
MALEFEMALE
finalBeneficiary
object (ActualBeneficiary) 
实际受益人
optional
企业必须
enterpriseRegisterDate
string 
企业注册日期
optional
格式 yyyy-MM-dd 企业必须
enterprisePeriodEndDate
string 
企业到期日期
optional
格式 yyyy-MM-dd 企业 enterprisePeriodOfValidityLongTerm=N时必填
enterprisePeriodOfValidityLongTerm
string 
企业到期日期是否长期有效
required
Y-是，N-否
enterpriseRegisterAddress
object 
企业注册地址
optional
企业必须
sameAddressFlag
enum<string> 
经营地址是否与注册地相同
optional
企业必须
Allowed values:
YN
enterpriseBusinessAddress
object 
企业经营地址
optional
经营地址与注册地址不一致时必须
periodOfValidityStart
string 
证件有效期始
optional
格式 yyyy-MM-dd 中国大陆个人时必填
periodOfValidityEnd
string 
证件有效期止
optional
格式 yyyy-MM-dd 中国大陆个人且非长期有效时必填
periodOfValidityLongTerm
enum<string> 
证件是否长期有效
optional
中国大陆个人时必填
Allowed values:
YN
defaultFlag
enum<string> 
是否默认持有人
required
Allowed values:
YN
completeFlag
enum<string> 
资料是否完善
required
不完善可通过持有人申请接口进行完善
Allowed values:
YN
createTime
string 
创建时间
required
Example
{
    "total": 0,
    "size": 0,
    "current": 0,
    "pages": 0,
    "records": [
        {
            "holderId": "string",
            "userId": "string",
            "holderType": "Enterprise",
            "holderCountry": "string",
            "identityType": "EMPLOYEE",
            "identityTypeMemo": "string",
            "authCertify": [
                {
                    "fileId": "string",
                    "fileName": "string",
                    "fileUrl": "string"
                }
            ],
            "holderCertify": [
                {
                    "fileId": "string",
                    "fileName": "string",
                    "fileUrl": "string"
                }
            ],
            "holderName": "string",
            "holderNameEn": "string",
            "firstNameEn": "string",
            "lastNameEn": "string",
            "holderStatus": "WAIT",
            "holderCertNo": "string",
            "holderCertType": "Identity_Card",
            "holderCertFront": {
                "fileId": "string",
                "fileName": "string",
                "fileUrl": "string"
            },
            "holderCertBack": {
                "fileId": "string",
                "fileName": "string",
                "fileUrl": "string"
            },
            "holderAddress": {
                "province": "string",
                "city": "string",
                "area": "string",
                "street": "string",
                "postalCode": "string"
            },
            "birthDate": "string",
            "gender": "MALE",
            "finalBeneficiary": {
                "beneficiaryName": "string",
                "beneficiaryCountry": "string",
                "beneficiaryCertType": "Identity_Card",
                "beneficiaryCertNo": "string",
                "beneficiaryCertFront": {
                    "fileId": "string",
                    "fileName": "string",
                    "fileUrl": "string"
                },
                "beneficiaryCertBack": {
                    "fileId": "string",
                    "fileName": "string",
                    "fileUrl": "string"
                },
                "beneficiaryAddress": {
                    "province": "string",
                    "city": "string",
                    "area": "string",
                    "street": "string",
                    "postalCode": "string"
                },
                "beneficiaryBirthDate": "string",
                "beneficiaryGender": "MALE",
                "equityRatio": 0,
                "periodOfValidityStart": "string",
                "periodOfValidityEnd": "string",
                "periodOfValidityLongTerm": "Y"
            },
            "enterpriseRegisterDate": "string",
            "enterprisePeriodEndDate": "string",
            "enterprisePeriodOfValidityLongTerm": "string",
            "enterpriseRegisterAddress": {
                "province": "string",
                "city": "string",
                "area": "string",
                "street": "string",
                "postalCode": "string"
            },
            "sameAddressFlag": "Y",
            "enterpriseBusinessAddress": {
                "province": "string",
                "city": "string",
                "area": "string",
                "street": "string",
                "postalCode": "string"
            },
            "periodOfValidityStart": "string",
            "periodOfValidityEnd": "string",
            "periodOfValidityLongTerm": "Y",
            "defaultFlag": "Y",
            "completeFlag": "Y",
            "createTime": "string"
        }
    ]
}
Modified at 2024-10-12 06:41:11
Previous
持有人结果通知(Card Holder Result Notification)
Next
持有人银行账户申请(Card Holder Beneficary Apply)
Built with