Documentatie/API-referentie

API REFERENCE

Saldo opvragen

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

Saldo opvragen

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.

Deze API vraagt het saldo van de YabandPay-wallet op.

Tip

Alleen superbeheerderaccounts van merchants mogen deze API aanroepen. Operator- en kassieraccounts zijn niet bevoegd.

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerderaccount
signStringSignatureVerplicht
methodStringv3.MerchantBalanceVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
commandStringgetBalanceVerplicht
currencyStringISO 4217-valutacode, bijvoorbeeld EUR of CHFVerplicht
nonce_stringStringWillekeurige tekenreeks van maximaal 32 tekensVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

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

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

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

Voorbeeld van een antwoord:

{
    "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": ""
}

Aanvullende informatie:

Beschrijving van antwoordparameters:
ParameterTypeBeschrijving
userStringUID van het superbeheerderaccount
timeStringHuidige tijdstempel
gateway_nameStringNaam van de instelling
wallet_idStringWallet-ID
currencyStringValutacode, ISO 4217
availableStringBeschikbaar saldo
reserveStringGereserveerd saldo
usableStringBesteedbaar bedrag, gelijk aan vailable - reserve
depositStringGeblokkeerd saldo