whalet
首页
开放API
  • 收款
  • 鲸卡
  • 收单
首页
开放API
  • 收款
  • 鲸卡
  • 收单
  1. 支付(Pay)
  • 接入指南
  • 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)
      POST
    • 确认支付(Pay Confirm)
      POST
    • 申请支付结果通知(Pay Result Notify)
      POST
  • 钱包(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. 支付(Pay)

申请支付(Pay Apply)

POST
applyPay

Request

Body Params application/json
userId
string 
用户ID
required
applyPayType
enum<string> 
支付类型
required
Allowed values:
ExtendCancelDateAddCardNum
paymentType
enum<string> 
付款方式
required
目前只支持 ACCOUNT_BALANCE
Allowed values:
ACCOUNT_BALANCEOFFLINE
payeeCardId
string 
收款卡ID
optional
applyPayType=ExtendCancelDate时必需
platformType
enum<string> 
收款平台
required
applyPayType=AddCardNum时必需
Allowed values:
Amazon_NAAmazon_EUAmazon_AUAmazon_JPAmazon_SGAmazon_AEAmazon_SAAmazon_TRAliExpresseBayDHGateQoo10_JPQoo10_SGShopee_SGShopee_IDEtsyWishCdiscountDartyFnacKAUFLANDDEMercadoLibreNeweggOttoRakutenWayfairMercariVintedOzonShopifyShopyyMagentoWoocommerceBigcommerceXShoppyOpencartUeeshopPaypalStripeCashAppVenmoAdyenPassionPayoneerLazada_IDTikTok_NATikTok_IDBukalapakJD_IDTokopediaSelf_BuildOtherWebPlatform
currency
string 
币种
optional
applyPayType=AddCardNum时必需
channelCountry
string 
渠道所在地
optional
applyPayType=AddCardNum时必需
paymentCurrency
string 
付款币种
optional
付款方式为ACCOUNT_BALANCE时必需
付款方式为OFFLINE默认为人民币
num
integer 
购买数量
required
>= 1
fundSource
enum<string> 
资金来源
optional
暂时只支持B2C
Allowed values:
B2CB2B
Example
{
    "userId": "string",
    "applyPayType": "ExtendCancelDate",
    "paymentType": "ACCOUNT_BALANCE",
    "payeeCardId": "string",
    "platformType": "Amazon_NA",
    "currency": "string",
    "channelCountry": "string",
    "paymentCurrency": "string",
    "num": 1,
    "fundSource": "B2C"
}

Responses

🟢200成功
application/json
Body
userId
string 
用户ID
required
payId
string 
支付购买ID
required
paymentAmount
number <double>
付款金额
required
paymentCurrency
string 
付款币种
required
qrCode
array[object (StorageFile) {3}] 
收款二维码
optional
付款方式为OFFLINE必需
fileId
string 
文件ID
required
<= 32 characters
fileName
string 
文件名
required
<= 255 characters
fileUrl
string 
文件地址
required
<= 255 characters
expireTime
string 
过期时间
required
Match pattern:
yyyy-MM-dd HH:mm:ss
Example
{
    "userId": "string",
    "payId": "string",
    "paymentAmount": 0,
    "paymentCurrency": "string",
    "qrCode": [
        {
            "fileId": "string",
            "fileName": "string",
            "fileUrl": "string"
        }
    ],
    "expireTime": "string"
}
Modified at 2025-05-16 06:09:22
Previous
查询支持的受益人银行账户国家/地区(Beneficiary Account Country Query)
Next
确认支付(Pay Confirm)
Built with