API REFERENCE
Consulter le solde
Paramètres
| Parameter | Type | Description | Obligatoire |
|---|---|---|---|
| data.command | string | getBalance | ✓ |
| data.currency | string | 货币代码,ISO 4217,例如EUR,CHF | ✓ |
| data.nonce_string | string | 随机字符串,不长于32位 | ✓ |
Cette API consulte le solde du portefeuille YabandPay.
Conseil
Seuls les comptes super administrateurs du marchand peuvent appeler cette API. Les comptes opérateur et caissier ne sont pas autorisés à l’appeler.
| Paramètre | Type | Description | Obligatoire |
|---|---|---|---|
| user | String | UID du compte super administrateur | |
| sign | String | Signature | Obligatoire |
| method | String | v3.MerchantBalance | Obligatoire |
| time | Long | Timestamp | Obligatoire |
- Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | command | String | getBalance | Obligatoire | | currency | String | Code devise ISO 4217, par exemple EUR ou CHF | Obligatoire | | nonce_string | String | Chaîne aléatoire de 32 caractères maximum | Obligatoire |
Exemple de signature :
Paramètres triés et concaténés dans une chaîne de requête au format URL
"command=getBalance¤cy=EUR&method=v3.MerchantBalance&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Signer stringA avec secret_key
La signature obtenue est :
"YOUR_SIGNATURE"
Exemple de requête :
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.MerchantBalance",
"time": 1708422208,
"data": {
"command": "getBalance",
"nonce_string": "tw5be5b7sry5prm96s",
"currency": "EUR"
}
}
Exemple de réponse :
{
"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": ""
}
Informations complémentaires :
Description des paramètres de réponse :
| Paramètre | Type | Description |
|---|---|---|
| user | String | UID du compte super administrateur |
| time | String | Horodatage actuel |
| gateway_name | String | Nom de l’établissement |
| wallet_id | String | ID du portefeuille |
| currency | String | Code devise, norme ISO 4217 |
| available | String | Solde disponible |
| reserve | String | Solde réservé |
| usable | String | Montant disponible, égal à vailable - reserve |
| deposit | String | Solde bloqué |
