Documentación/Referencia de API

API REFERENCE

Consultar saldo

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

Consultar saldo

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.

Parámetros

ParameterTypeDescripciónObligatorio
data.commandstringgetBalance✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.nonce_stringstring随机字符串,不长于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ámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestrador
signStringSignatureObligatorio
methodStringv3.MerchantBalanceObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringgetBalanceObligatorio
currencyStringISO 4217 currency code, for example EUR or CHFObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

"command=getBalance&currency=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ámetroTipoDescripción
userStringUID de la cuenta de superadminestrador
timeStringMarca de tiempo actual
gateway_nameStringInstitution name
wallet_idStringWallet ID
currencyStringCódigo de moneda ISO 4217
availableStringAvailable balance
reserveStringReserve balance
usableStringSpendable amount, equal to vailable - reserve
depositStringFrozen balance