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

申请提现/付款(Payout Apply)

POST
applyWithdraw

Request

Body Params application/json
userId
string 
用户ID
required
tradeType
enum<string> 
交易类型
required
Allowed values:
WITHDRAWPAYMENT
currency
string 
币种
required
toCurrency
string 
目标币种
required
beneficiaryAccountId
string 
受益人账户ID
required
与交易类型保持一致
需与toCurrency保持一致
amount
number <double>
金额
optional
amount和actualAmount任选其一填写
rateId
string 
汇率ID
optional
币种与目标币种不相同时必填
<= 70 characters
postscript
string 
附言
optional
目标币种非人民币必填
<= 140 characters
actualAmount
number <double>
到账金额
optional
amount和actualAmount任选其一填写
payerName
string 
optional
付款人名称(需要支付额外的费用且只支持实名认证名称,目标币种非人民币时可填)
paymentCertify
array [object {3}] 
付款凭证
optional
tradeType=PAYMENT且toCurrency非CNY时必填
>= 1 items<= 1 items
fileId
string 
文件ID
required
<= 32 characters
fileName
string 
文件名
required
<= 255 characters
fileUrl
string 
文件地址
required
<= 255 characters
relationshipSender
enum<string> 
optional
与付款人关系,外币提现/付款并且P2P时必填
Allowed values:
FatherMotherSpouseSonDaughterBrotherSisterFriendEmployerColleagueSelfGuardianHusbandWifeEmployeeIn-LawsCousinPartnersAuntUncleBank NotesOwn AccountSponsorDirectorAuthorized SignatoryCorporate RepresentativeOwnerBrother-in-lawBusinessChildCorporateDaughter-in-lawFamilyFather-in-lawFriend's FatherFriend's MotherGrand DaughterGrand FatherGrand MotherGrand SonMother-in-lawNeighbourNephewNieceParentRelativeSister-in-lawSon-in-lawStep Child
remittancePurpose
enum<string> 
optional
汇款目的,外币提现/付款
Allowed values:
Business Profits to ParentsBusiness TravelFamily MaintenanceSalarySavingsMedical ExpensesTuition FeesEducation SupportGiftHome ImprovementDebt SettlementReal EstateTaxesAdvanced Goods PaymentsCharitable DonationConference or Training FeeEmployee CompensationEvents or Competition Participation ExpensesExport Goods PaymentsGoods and ServicesGoods ExportedLoan RepaymentOther BusinessOther Business ServicesRent Property ExpensesSalary PaymentSoftware ExportTravel Cost Accomodation CostTravel ExpensesBusiness profits to Parents
fundSource
enum<string> 
资金来源
optional
Allowed values:
B2CB2B
Example
{
    "userId": "string",
    "tradeType": "WITHDRAW",
    "currency": "string",
    "toCurrency": "string",
    "beneficiaryAccountId": "string",
    "amount": 0,
    "rateId": "string",
    "postscript": "string",
    "actualAmount": 0,
    "payerName": "string",
    "paymentCertify": [
        {
            "fileId": "string",
            "fileName": "string",
            "fileUrl": "string"
        }
    ],
    "relationshipSender": "Father",
    "remittancePurpose": "Business Profits to Parents",
    "fundSource": "B2C"
}

Responses

🟢200成功
application/json
Body
tradeId
string 
交易ID
required
currency
string 
币种
required
amount
number <double>
金额
required
提现/付款金额
feeAmount
number <double>
手续费金额
required
feeCurrency
string 
手续费币种
required
payerNameFee
number <double>
optional
付款人名称费用
payerNameFeeCurrency
string 
optional
付款人名称费用币种
actualAmount
number <double>
预计到账金额
optional
到账金额
actualAmountCurrency
string 
预计到账金额币种
optional
到账金额币种
Example
{
    "tradeId": "string",
    "currency": "string",
    "amount": 0,
    "feeAmount": 0,
    "feeCurrency": "string",
    "payerNameFee": 0,
    "payerNameFeeCurrency": "string",
    "actualAmount": 0,
    "actualAmountCurrency": "string"
}
Modified at 2025-05-16 06:08:42
Previous
提现(Payout)
Next
确认提现/付款(Payout Confirm)
Built with