whalet
首页
开放API
  • 收款
  • 鲸卡
  • 收单
首页
开放API
  • 收款
  • 鲸卡
  • 收单
  1. 首页
  • 接入指南
  • 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. 首页

附录

省市区信息#

省市区信息

更新日志#

1.0.5 供应商付款支持人民币到账 2024-09-05
支持供应商付款添加人民币账户
支持两种付款方式：1. 付款外币，到账人民币 2. 指定付款人民币到账金额
涉及接口：applyWithdraw 、queryBeneficiaryBankAccountFields 、applyBeneficiaryBankAccount

更新日志#

1.0.6 提现优化 2025-01-16
原币提现/付款支持付款人名称
供应商原币付款支持付款至电子钱包
原币提现/付款支持非同币种
提现绑定受益人新增支持的受益人银行账户国家/地区查询接口
涉及接口：applyWithdraw 、queryWithdrawRate、queryWithdrawRecord、queryPaymentRecord 、queryBeneficiaryBankAccountFields、applyBeneficiaryBankAccount、queryBeneficiaryBankAccountCountry
queryWithdrawRate
入参
删除 tradeType
新增 toCurrency 目标币种
出参
新增 toCurrency 目标币种
applyWithdraw
入参
修改 toCurrency 到账币种
修改 rateId 币种与目标币种不相同时必填
修改 amount amount和actualAmount任选其一填写
修改 actualAmount amount和actualAmount任选其一填写
新增 payerName 付款人名称(需要支付额外的费用，目标币种非人民币时可填)
新增 remittancePurpose 汇款目的(目标币种非人民币时必填)
新增 relationshipSender 与付款人关系(目标币种非人民币时并且P2P时必填)
出参
新增 payerNameFee 付款人名称费用
新增 payerNameFeeCurrency 付款人名称费用币种
新增 actualAmount 到账金额
新增 actualAmountCurrency 到账金额币种
修改 amount 提现/付款金额(包含手续费和付款人名称费用)
删除 estimateAmount 预计到账金额
删除 estimateAmountCurrency 预计到账金额币种
删除 deductAmount 扣款金额
删除 deductAmountCurrency 扣款金额币种
queryWithdrawRecord queryPaymentRecord
新增 payerNameFee 付款人名称费用
新增 payerNameFeeCurrency 付款人名称费用币种
新增 payerName 付款人名称
queryBeneficiaryBankAccountFields
新增 countryCode 付款国家
新增 beneficiaryAccountCategory 受益人银行账户种类
applyBeneficiaryBankAccount
新增 beneficiary.phoneAreaCode 预留手机号对应的国际电话区号
新增 beneficiary.beneficiaryCertType 受益人证件类型
新增 beneficiary.issueDate 受益人证件有效开始日期
新增 beneficiary.expiryDate 受益人证件有效结束日期
新增 beneficiary.beneficiaryAddress2 受益人地址2
新增 beneficiary.beneficiaryAddress3 受益人地址3
新增 beneficiary.beneficiaryCountry 受益人所在地(国家/地区二字码)
新增 beneficiary.beneficiaryProvince 受益人所在地(省名称)
新增 beneficiary.beneficiaryCity 受益人所在地(城市名称)
新增 beneficiary.beneficiaryDistrict 受益人所在地(区县名称)
新增 beneficiary.email 受益人邮箱
新增 beneficiary.postalCode 受益人邮编
新增 beneficiary.firstName 银行账户英文名称 - 名
新增 beneficiary.middleName 银行账户英文名称 - 中间名
新增 beneficiary.lastName 银行账户英文名称 - 姓
新增 beneficiary.bankAcctType 银行账户类型
新增 beneficiary.bankBranchCode 支行Code
新增 beneficiary.bankRoutingNumber Routing Number
新增 beneficiary.bankSortCode Sort Code
新增 beneficiary.zenginCode zenginCode
新增 beneficiary.iBan iBan账号
新增 beneficiary.walletId 钱包ID（电子钱包时必须）

更新日志#

1.0.7 新增银行证明信 2025-02-25
电商收款新增申请银行证明信接口
涉及接口：applyBankLetter

更新日志#

1.0.8 更新申请支付接口参数名 2025-03-04
电商收款新增申请银行证明信接口
涉及接口：applyPay
修改出参 qRCode为qrCode

更新日志#

1.0.9 用户入网地址参数调整 2025-03-12
用户入网接口
涉及接口：userRegister
修改 address 备注为“地址信息（个人证件地址/企业注册地址）”
修改 sameAddressFlag 备注为“经营地址是否与注册地址一致（企业）/居住地址是否与证件地址一致（个人）”
修改 members.address 备注为“证件地址”
新增 resideAddress 居住地址
新增 members.resideAddress 居住地址
新增 members.sameAddressFlag 居住地址是否与证件地址一致
1.1.0 fundSource参数调整 2025-04-14
fundSource入参调整为非必填
涉及接口：applyWithdraw
修改入参 fundSource 非必填
queryWithdrawRate
修改入参 fundSource 非必填
applyPay
修改入参 fundSource 非必填
1.1.1 绑定受益人银行账户参数调整 2025-05-19
涉及接口：applyBeneficiaryBankAccount
新增 beneficiary.bankCountry 开户行所在国家/地区
Modified at 2025-05-19 03:29:14
Previous
Integration Guidelines
Next
Appendix
Built with