Balance
This API is used to qurey the balance of YabandPay wallet.
[!TIP|style:flat]
This API can only be called by the merchant super admin account; the operator or cashier accounts do not have permission to call this API.
API URL:https://mapi.yabandpay.com/Payments
Method:POST
POST data type:Json
Parameter | Type | Description | Required |
---|---|---|---|
user | String | the UID of super admin account | Required |
sign | String | signature | Required |
method | String | v3.CreatePayments | Required |
time | Long | timestamp | Required |
- Parameter
Parameter | Type | Description | Required |
---|---|---|---|
commond | String | getBalance | Required |
currency | String | ISO 4217, For example EUR, CHF | Required |
nonce_string | String | Random string, no longer than 32 bits | Required |
Signature:
Lexicographical sequence and URL key-value format new string
"commond=getBalance¤cy=EUR&method=v3.MerchantBalance&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Use stringA and secret_key to get stringSign
Get Signature:
"9abdb20d59573ded6b415adf871aeddcb7896ad954e7828b39d9f14b65a3464a"
Example Request:
{
"user": "036870",
"sign": "9abdb20d59573ded6b415adf871aeddcb7896ad954e7828b39d9f14b65a3464a",
"method": "v3.MerchantBalance",
"time": 1708422208,
"data": {
"commond": "getBalance",
"nonce_string": "tw5be5b7sry5prm96s",
"currency": "EUR"
}
}
Example Response:
{
"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": ""
}
More Information:
The response parameters are described as follows:
Parameter | Type | Description |
---|---|---|
user | String | the UID of super admin account |
time | String | timestamp |
gateway_name | String | The name of the payment institution, namely YabandPay |
wallet_id | String | wallet ID |
currency | String | currency, ISO 4217 |
available | String | available amount |
reserve | String | reserve amount |
usable | String | usable amount, i.e. vailable - reserve |
deposit | String | deposit amount |