whalet
首页
开放API
  • 收款
  • 鲸卡
  • 收单
首页
开放API
  • 收款
  • 鲸卡
  • 收单
  1. 电商收款(B2C)
  • 接入指南
  • 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)
        POST
      • 获取收款卡平台配置(Platform Query for B2C)
        POST
      • 获取开通收款卡持有人(Card Holder Query for B2C)
        POST
      • 查询开卡数(Card number Query for B2C)
        POST
      • 绑定/添加店铺(Bind/Unbind Shop for B2C)
        POST
      • 注销收款卡((Card Cancel for B2C))
        POST
      • 查询收款卡详情(Card Detail Query for B2C)
        POST
      • 注销收款卡结果通知(Card Cancel Result Notify for B2C)
        POST
      • 查询店铺(Shop Query for B2C)
        POST
      • 查询收款卡(Card Query for B2C)
        POST
      • 绑定/添加店铺结果通知(Shop Bind/Unbind/Add Result Notify for B2C)
        POST
      • 申请银行证明信(Bank Letter Apply For B2C)
        POST
    • 申请收款卡结果通知(Virtual Account Notify for B2C)
      POST
  • 收款(Collections)
    • 收款到账通知(Collection Received Notify)
    • 关联外贸订单(Trade Order Bind Apply for B2B)
    • 关联外贸订单结果通知(Trade Order Bind Notify for B2B)
  • 订单(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)
    • 确认提现/付款(Payout Confirm)
    • 申请提现/付款结果通知(Payout Result Notify)
    • 查询汇率(Rate Inquiry)
    • 查询受益人银行账户字段信息(Beneficiary Account Fields Query)
    • 绑定受益人银行账户(Benificiary Account Apply)
    • 绑定受益人银行账户结果通知(Benificiary Account Result Notify)
    • 删除受益人银行账户(Benificiary Account Delete)
    • 查询支持的受益人银行账户国家/地区(Beneficiary Account Country Query)
  • 支付(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. 电商收款(B2C)

申请收款卡(Virtual Account Apply for B2C)

POST
applyPayeeCard

Request

Body Params application/json
userId
string 
用户ID
required
<= 30 characters
currency
string 
币种
required
国际标准货币三位代码
<= 3 characters
platformType
enum<string> 
收款平台
required
Allowed values:
Amazon_NAAmazon_EUAmazon_AUAmazon_JPAmazon_SGAmazon_AEAmazon_SAAmazon_TRAliExpresseBayDHGateQoo10_JPQoo10_SGShopee_SGShopee_IDEtsyWishCdiscountDartyFnacKAUFLANDDEMercadoLibreNeweggOttoRakutenWayfairMercariVintedOzonShopifyShopyyMagentoWoocommerceBigcommerceXShoppyOpencartUeeshopPaypalStripeCashAppVenmoAdyenPassionPayoneerLazada_IDTikTok_NATikTok_IDBukalapakJD_IDTokopediaSelf_BuildOtherWebPlatformTRADE_PAYEEShopee_PHLazada_PHTikTok_PHLazada_SGTikTok_SG
applyShopStatus
enum<string> 
申请店铺状态
required
Allowed values:
OWN_SHOPNONE_SHOP
shopName
string 
店铺名称
required
申请店铺状态为NONE_SHOP时可为店铺暂用名
<= 100 characters
sellGoodsType
enum<string> 
经营类别
optional
platformType非OtherWebPlatform是必需
Allowed values:
ELECTRONICSFOODSCLOTHINGOFFICEBAGSTOYHAIRDRESSINGARTWORKHOMEIRONWAREDAILYFITNESSOTHER
serviceTradeType
enum<string> 
服贸经营类别
optional
platformType=OtherWebPlatform是必需
Allowed values:
ADVISORY_SERVICESADVERTISING_SERVICESGAMETRANSLATIONSOFTWARE_SERVICESOTHER
serviceTradeTypeExtra
string 
服务贸易其他
optional
serviceTradeType=OTHER时必需
<= 200 characters
customizeShopName
string 
店铺别名
optional
<= 200 characters
annualSales
enum<string> 
预计年销售额
required
Allowed values:
10203040
holderId
string 
持有人ID
required
<= 30 characters
holderBankAcctId
string 
持有人银行账户ID
optional
亚马逊平台必填
<= 40 characters
shopUrl
string 
店铺链接
optional
申请店铺状态为OWN_SHOP时必需
<= 150 characters
selfBuildName
string 
建站工具名称
optional
平台为自建站时必需
<= 200 characters
channelCountry
string 
银行所在地
required
接口返回
shopHoldCertify
array[object (StorageFile) {3}] 
店铺持有证明
optional
applyShopStatus=OWN_SHOP时必需
请上传您的店铺管理主页载图等相关证明文件
<= 10 items
fileId
string 
文件ID
required
<= 32 characters
fileName
string 
文件名
required
<= 255 characters
fileUrl
string 
文件地址
required
<= 255 characters
payFac
array[object (PayFac) {2}] 
支付服务商
optional
根据接口返回填写
payFacId
string 
支付服务商ID
required
<= 40 characters
payFacName
string 
支付服务商名称
required
<= 255 characters
Example
{
    "userId": "string",
    "currency": "str",
    "platformType": "Amazon_NA",
    "applyShopStatus": "OWN_SHOP",
    "shopName": "string",
    "sellGoodsType": "ELECTRONICS",
    "serviceTradeType": "ADVISORY_SERVICES",
    "serviceTradeTypeExtra": "string",
    "customizeShopName": "string",
    "annualSales": "10",
    "holderId": "string",
    "holderBankAcctId": "string",
    "shopUrl": "string",
    "selfBuildName": "string",
    "channelCountry": "string",
    "shopHoldCertify": [
        {
            "fileId": "string",
            "fileName": "string",
            "fileUrl": "string"
        }
    ],
    "payFac": [
        {
            "payFacId": "string",
            "payFacName": "string"
        }
    ]
}

Responses

🟢200成功
application/json
Body
payeeCardId
string 
收款卡ID
required
用于后续查询
shopId
string 
店铺ID
required
Example
{
    "payeeCardId": "string",
    "shopId": "string"
}
Modified at 2024-10-14 01:06:32
Previous
获取外贸收款渠道(Channel Banks Query for B2B)
Next
获取收款卡平台配置(Platform Query for B2C)
Built with