Documentation/Référence API

API REFERENCE

Consulter le solde

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Consulter le solde

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters3

Required fields first

余额查询

commandRequiredstringdata.commandgetBalance
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Paramètres

ParameterTypeDescriptionObligatoire
data.commandstringgetBalance✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.nonce_stringstring随机字符串,不长于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ètreTypeDescriptionObligatoire
userStringUID du compte super administrateur
signStringSignatureObligatoire
methodStringv3.MerchantBalanceObligatoire
timeLongTimestampObligatoire
  • 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&currency=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ètreTypeDescription
userStringUID du compte super administrateur
timeStringHorodatage actuel
gateway_nameStringNom de l’établissement
wallet_idStringID du portefeuille
currencyStringCode devise, norme ISO 4217
availableStringSolde disponible
reserveStringSolde réservé
usableStringMontant disponible, égal à vailable - reserve
depositStringSolde bloqué