文档中心/API 接口

API REFERENCE

提款

POSThttps://mapi.yabandpay.com/Payments
实际接口
API PLAYGROUND · 实际接口

提款

POSThttps://mapi.yabandpay.com/Payments
填写凭据后自动签名

请求参数6

先填写必填项

提款

command必填stringdata.commandpayout
amount必填numberdata.amount提款金额,2位小数,例如19.99
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
reference必填stringdata.reference备注
notify_url必填stringdata.notify_url异步通知地址
nonce_string必填stringdata.nonce_string随机字符串,不长于32位

凭据仅在当前页面使用。secret_key 不保存,也不发送给文档服务器。

此接口对YabandPay的钱包余额进行提款

小贴士

1、提款金额不能大于可支配余额(usable)

2、此API仅限商户超级管理员账号调用,操作员或收银员账号无权调用。

参数类型描述是否必填
userString超级管理员账号的UID必填
signString签名必填
methodStringv3.MerchantBalance必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
commandStringpayout必填
amountString提款金额,2位小数,例如19.99必填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
referenceString备注必填
notify_urlString异步通知地址必填
nonce_stringString随机字符串,不长于32位必填

签名示例:

拼接为URL方式并排序后的字符串

"amount=100.01&command=payout&currency=EUR&method=v3.MerchantBalance&nonce_string=2yx20x4c6dswedikxs&notify_url=https://www.yabandpay.com/notify&reference=456789&time=1708482257&user=036870"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "036870",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.MerchantBalance",
    "time": 1708482257,
    "data": {
        "command": "payout",
        "nonce_string": "2yx20x4c6dswedikxs",
        "amount": 100.01,
        "currency": "EUR",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "036870",
        "time": 1708482257,
        "gateway_name": "YabandPay",
        "payout_id": "0594bf99-fce7-3784-28f7-e8e76ad01989",
        "currency": "EUR",
        "amount": "100.01",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify",
        "state": "awaiting approval"
    },
    "message": ""
}

更多信息:

返回参数说明如下:
参数类型描述
userString超级管理员账号的UID
timeString当前时间戳
gateway_nameString钱包机构名称
payout_idStringpayout订单号
currencyString货币代码,ISO 4217
amountString提款金额
referenceString备注
notify_urlString异步通知地址
stateString订单状态。目前有6种状态: awaiting approval, pending, failed, completed, declined, cancelled