文档中心/API 接口

API REFERENCE

余额查询

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

余额查询

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

请求参数3

先填写必填项

余额查询

command必填stringdata.commandgetBalance
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
nonce_string必填stringdata.nonce_string随机字符串,不长于32位

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

此接口查询YabandPay的钱包余额

小贴士

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

参数类型描述是否必填
userString超级管理员账号的UID
signString签名必填
methodStringv3.MerchantBalance必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
commandStringgetBalance必填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
nonce_stringString随机字符串,不长于32位必填

签名示例:

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

"command=getBalance&currency=EUR&method=v3.MerchantBalance&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "036870",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.MerchantBalance",
    "time": 1708422208,
    "data": {
        "command": "getBalance",
        "nonce_string": "tw5be5b7sry5prm96s",
        "currency": "EUR"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "036870",
        "time": 1708422208,
        "gateway_name": "YabandPay",
        "wallet_id": "WA156227511825",
        "currency": "EUR",
        "available": "9999788.98",
        "reserve": "200.00",
        "usable": "9999988.98",
        "deposit": "20.00"
    },
    "message": ""
}

更多信息:

返回参数说明如下:
参数类型描述
userString超级管理员账号的UID
timeString当前时间戳
gateway_nameString机构名称
wallet_idString钱包ID
currencyString货币代码,ISO 4217
availableString可用余额
reserveString储备金余额
usableString可支配金额,其值等于vailable - reserve
depositString冻结余额