API REFERENCE
Consultar saldo
Parámetros
| Parameter | Type | Descripción | Obligatorio |
|---|---|---|---|
| data.command | string | getBalance | ✓ |
| data.currency | string | 货币代码,ISO 4217,例如EUR,CHF | ✓ |
| data.nonce_string | string | 随机字符串,不长于32位 | ✓ |
Esta API consulta el saldo de la cartera de YabandPay.
Consejo
Solo las cuentas de superadminestrador del comercio pueden llamar a esta API. Las cuentas de operador y cajero no tienen autorización para hacerlo.
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| user | String | UID de la cuenta de superadminestrador | |
| sign | String | Signature | Obligatorio |
| method | String | v3.MerchantBalance | Obligatorio |
| time | Long | Timestamp | Obligatorio |
- Parámetros
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| command | String | getBalance | Obligatorio |
| currency | String | ISO 4217 currency code, for example EUR or CHF | Obligatorio |
| nonce_string | String | Cadena aleatoria de un máximo de 32 caracteres | Obligatorio |
Ejemplo de firma:
Parámetros ordenados y concatenados en una cadena de consulta con formato de URL
"command=getBalance¤cy=EUR&method=v3.MerchantBalance&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Firme la cadena A con secret_key
La firma resultante es:
"YOUR_SIGNATURE"
Ejemplo de solicitud:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.MerchantBalance",
"time": 1708422208,
"data": {
"command": "getBalance",
"nonce_string": "tw5be5b7sry5prm96s",
"currency": "EUR"
}
}
Ejemplo de respuesta:
{
"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": ""
}
Información adicional:
Descripción de los parámetros de respuesta:
| Parámetro | Tipo | Descripción |
|---|---|---|
| user | String | UID de la cuenta de superadminestrador |
| time | String | Marca de tiempo actual |
| gateway_name | String | Institution name |
| wallet_id | String | Wallet ID |
| currency | String | Código de moneda ISO 4217 |
| available | String | Available balance |
| reserve | String | Reserve balance |
| usable | String | Spendable amount, equal to vailable - reserve |
| deposit | String | Frozen balance |
