whalet
    whalet
    • 接入指南
    • 附录
    • 认证授权(Authorize)
      • 获取令牌
        POST
      • 文件上传
        POST
    • 连通性验证(Connectivity)
      • 通知(Webhook)
        • 连通性验证通知(connectivityNotify)
      • 连通性验证(connectivity)
        POST
    • 用户入网(UserOnboarding)
      • 入网申请(Onboarding)
        • 用户入网申请(User Onboarding Apply)
      • 补充资料(EDD)
        • EDD补充资料查询(Edd Replenish Query)
        • EDD补充资料提交(Edd Replenish Submit)
      • 通知(Webhook)
        • 入网结果通知(User Onboarding Result Notification)
        • EDD补充资料通知(Edd Replenish Notify)
        • EDD补充资料结果通知(Edd Replenish Result Notify)
    • 收款(Payee)
      • 持有人(Card Holder)
        • 持有人申请(Card Holder Apply)
        • 持有人查询(Card Holder Query)
        • 持有人银行账户申请(Card Holder Beneficary Apply)
        • 持有人银行账户查询(Card Holder Beneficary Query)
      • 开卡(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)
          • 查询店铺(Shop Query for B2C)
          • 查询收款卡(Card Query for B2C)
          • 申请银行证明信（Bank Letter Apply For B2C）
      • 订单(Order)
        • 外贸收款(Trade Order)
          • 订单申请(Trade Order Apply for B2B)
          • 订单详情(Trade Order Query Detail for B2B)
          • 分页查询(Trade Order Query List for B2B)
          • 关联外贸订单(Trade Order Bind Apply for B2B)
        • 电商收款(Shop Order)
          • 查询上传订单结果(Query the results of the uploaded order for B2C)
          • 上传订单(Shop Order Upload for B2C)
      • 通知(Webhook)
        • 模拟入账通知Mock(mockPayeeNotify)
        • 持有人结果通知(Card Holder Result Notification)
        • 持有人银行账户结果通知(Card Holder Beneficary Result Notify)
        • 申请收款卡结果通知(Virtual Account Notify for B2C)
        • 收款到账通知(Payee Received Notify)
        • 关联外贸订单结果通知(Trade Order Bind Notify for B2B)
        • 绑定/添加店铺结果通知(Shop Bind/Unbind/Add Result Notify for B2C)
        • 注销收款卡结果通知(Card Cancel Result Notify for B2C)
        • 上传订单结果通知(Upload Order Result Notify for B2C)
    • 收单(Acquiring)
      • 接入方式
      • 支付方式
      • 测试数据
      • 店铺(Shop)
        • 获取可用的支付方式
        • 添加店铺
        • 查询店铺详情
        • 申请店铺支付方式
      • Hosted Payment Page
        • 创建支付链接
        • 查询交易信息
      • Embedded Payment
        • 接入方式
        • 创建支付会话
        • 创建支付
      • Direct Payments
        • 获取卡详情
        • 创建付款
        • 获取银行列表
      • 退款(Refund)
        • 退款申请
      • 拒付(Chargeback)
        • 拒付详情
        • 查询拒付原因
        • 拒付申诉
        • 拒付接受
      • 通知(Webhook)
        • 添加店铺结果通知
        • 申请店铺支付方式结果通知
        • 支付结果通知
        • 退款结果通知
        • 拒付产生通知
        • 拒付结果通知
        • 欺诈通知
        • 支付创建通知
      • 插件(Plugin)
        • WordPress/Woocommerce插件安装说明
        • Shoplazza安装说明
      • 撤销(Cancel)
        • 撤销申请
      • 补充订单物流信息
        POST
    • 鲸卡(VCC)
      • 鲸卡钱包(Account/Wallet)
        • 开通鲸卡钱包
        • 鲸卡钱包查询
        • 鲸卡钱包充值
        • 钱包交易查询
      • 鲸卡管理(Card)
        • 可用卡bin查询
        • 创建鲸卡
        • 查询鲸卡信息
        • 注销鲸卡
        • 锁定鲸卡
        • 解锁鲸卡
        • 鲸卡充值
        • 鲸卡提现
        • 鲸卡交易查询
      • 通知(Webhook)
        • 创建鲸卡通知
        • 注销鲸卡通知
        • 锁定鲸卡通知
        • 解锁鲸卡通知
        • 鲸卡交易通知
        • 鲸卡钱包交易通知
    • 购买(Buy)
      • 通知(Webhook)
        • 申请支付结果通知(Pay Result Notify)
      • 申请支付(Pay Apply)
      • 确认支付(Pay Confirm)
    • 出金(Payout)
      • 通知(Webhook)
        • 申请提现/付款结果通知(Payout Result Notify)
        • 绑定受益人银行账户结果通知(Benificiary Account Result Notify)
      • 获取申请提现/付款信息(Get Payout Apply Info)
      • 申请提现/付款(Payout Apply)
      • 确认提现/付款(Payout Confirm)
      • 查询汇率(Rate Inquiry)
      • 查询受益人银行账户字段信息(Beneficiary Account Fields Query)
      • 绑定受益人银行账户(Benificiary Account Apply)
      • 删除受益人银行账户(Benificiary Account Delete)
      • 查询支持的受益人银行账户国家/地区(Beneficiary Account Country Query)
    • 交易(Trade)
      • 交易查询(Trade Query)
        • 收款记录(Payee Query)
        • 提现记录(Withdraw Query)
        • 付款记录(Payment Query)
        • 支付记录(Pay Query)
      • 补充资料(ReMaterials)
        • 通知(Webhook)
          • 交易补充资料通知(Trade Replenish Notify)
          • 交易补充资料结果通知(Trade Replenish Result Notify)
        • 交易补充资料提交(Trade Replenish Submit)
    • 钱包(Wallet)
      • 币种余额(Currency Balance)
      • 平台余额(Platform Balance)
    • Mock
      • 入账通知Mock(mockPayeeNotify)
    • 数据模型
      • Schemas
        • TradeAcquiringNofDetail
        • TradeAcquiringDisputeType
        • OrderUploadInfo
        • StorageFile
        • WhaletCardId
        • IndustryCode
        • Address
        • WhaletCardAddress
        • AcquiringShopStatus
        • Member
        • WhaletCardInfo
        • AcquiringShopInfo
        • EddItem
        • WhaletCardTransactionInfo
        • AcquiringShopMethodInfo
        • PayFac
        • WhaletCardBin
        • ActualBeneficiary
        • WhaletCardBinVerification
        • AcquiringShopMethodStatus
        • EddItem1
        • WhaletCardBinCardLimit
        • Edd
        • WhaletCardIdTrans
        • TradeAcquiringChargebackStatus
        • Shop
        • WhaletCardAccountTransactionInfo
        • TradeAcquiringChargebackHandleType
        • TradePayeeOrder
        • WhaletCardAccountInfo
        • TradeAcquiringHandleStatus
        • Bank
        • WhaletCardTransactionType
        • CardSupplier
        • TradeAcquiringChargebackDetail
        • WhaletCardAccountTransactionType
        • AcquiringProductStatus
        • Card
        • WhaletCardTransactionStatus
        • FeeDetail
        • UserHolder
        • UserHolderBankAccount
        • ResultNotify
        • PlatformType
        • VirtualAccountBank
        • Balance
        • ListObject
        • AcquiringChargebackDefenseDocument
        • YesOrNo
        • TradeAcquiringChargebackReasonInfo
        • TradeAcquiringChargebackReason
        • FeeRuleDetail
        • SupplierType
        • FeeRule
        • PayeeCardStatus
        • BankCode
        • ShopStatus
        • BeneficiaryBankAccountField
        • BeneficiaryAccountType
        • BeneficiaryBankAccount
        • SellGoodsType
        • CertificateType
        • FundSource
        • ConnectivityGuideRequestBody
        • ServiceTradeType
        • AcquiringGoods
        • AcquiringPaymentMethod
        • TradeAcquiringLinkStatus
        • TradeAcquiringLinkInfo
        • TradeAcquiringLinkCustomerInfo
        • TradeAcquiringLinkGoodsInfo
        • TradeAcquiringOrderInfo
        • TradeAcquiringInfo
        • TradeAcquiringRefundInfo
        • Currency
        • RemittancePurpose
        • RelationshipSender
        • ConnectivityGuideResponseBody
        • BeneficiaryAccountCategory
      • AcquiringPayByBankDetail
      • AcquiringDigitalWalletDetail
      • AcquiringPixDetail
      • AcquiringCaptureType
      • AcquiringActionType
      • AcquiringRedirectData
      • AcquiringCardBrand
      • AcquiringBoletoDetail
      • AcquiringPicpayBrazilDetail
      • AcquiringPaypalBrazilDetail
      • AcquiringPaymentDetailBase
      • AcquiringGooglePayDetail
      • AcquiringApplePayDetail
      • AcquiringBcmcDetail
      • AcquiringIdealDteail
      • AcquiringUserAgent
      • AcquiringAffirmDetail
      • AcquiringKlarnaDetail
      • AcquiringCashAppPayDetail
      • AcquiringEpsDetail
      • AcquiringSepaDebitDetail
      • AcquiringLinkDetail
      • AcquiringAddress
      • AcquiringChannel
      • AcquiringSubmitDetail
      • OpenApiAcquiringSupplementOrderLogisticsForm
      • OpenRestfulResultVoid
      • UserAgent
      • AcquiringBrowserInfo
      • AcquiringProduct
      • Browser
      • Platform
      • CountryCode
      • AcquiringCustomer
      • OS
      • AcquiringOrder
      • Engine
      • LogisticsInfo
      • AcquiringDeviceData
      • AcquiringCardDetail
      • AcquiringMethodType
      • AcquiringAction
      • Currency
      • AcquiringQrCodeData
      • AcquiringMethodDetail
      • AcquiringCustomData

    附录

    省市区信息#

    省市区信息

    更新日志#

    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 开户行所在国家/地区
    1.2.0 入网支持新加坡、美国企业 2025-05-19
    涉及接口：userRegister
    所有地址对象新增street2
    新增einNumber EIN(雇主识别号码)编号
    新增einImage EIN(雇主识别号码)文件
    新增gstNumber GST(商品及服务税)编号
    新增member.phoneAreaCode 国际区号
    新增member.phone 联系电话
    新增member.email 邮箱
    新增member.jobTitle 职务
    新增member.resideCountryCode 居住国家/地区
    1.3.0 入网新增企业必填项“股权证明文件” 2026-01-13
    涉及接口：userRegister
    新增equityProofFile 股权证明文件
    1.4.0 新增欺诈通知 webhook 2026-02-05
    1.4.1 拒付产生通知和拒付结果通知新增字段 2026-02-05
    新增rdrFlag -是否RDR
    新增disputeType -争议类型
    1.4.2 创建付款新增支付方式 2026-02-05
    涉及接口：createPayment
    新增支付方式affirm、klarna、cashapp、eps、sepa_debit支付方式
    出参新增 qrCodeData.qrExpireTime 过期时间
    1.4.3 日期格式更新 2026-02-09
    涉及接口：createPaymentPage
    linkValidity格式改为UTC格式：yyyy-MM-dd'T'HH:mm:ssXXX
    1.4.4 收单支付clientIp，origin必填 2026-02-26
    涉及接口：createPayment
    入参deviceData中clientIp修改为必填，新增origin-支付来源URL
    1.4.5 电商订单上传优化 2026-03-09
    涉及接口：orderUpload
    出参
    新增 orderUploadId 订单上传ID
    新增 shopId 店铺ID
    新增 uploadStatus 上传状态
    新增 orderCount 订单总数
    新增接口：queryOrderUploadResult 电商收款订单上传结果查询
    新增webhook通知 orderUploadResultNotify 电商收款订单上传结果通知
    1.4.6 出金新增获取申请提现/付款信息接口 2026-03-09
    新增接口：getApplyWithdrawInfo 获取申请提现/付款信息
    1.4.7 收单新增支持撤销支付，支付提交通知 2026-03-09
    新增接口：applyTradeAcquiringCancel 申请收单撤销
    新增webhook通知 acquiringChargeCreateNotify 收单支付创建通知
    上一页
    接入指南
    下一页
    获取令牌
    Built with