API REFERENCE

Consultar saldo

YabandPay documentation·Atualizado em 26 de out. de 2026

Parâmetros

Parameter	Type	Descrição	Obrigatório
data.command	string	getBalance	✓
data.currency	string	货币代码，ISO 4217，例如EUR，CHF	✓
data.nonce_string	string	随机字符串，不长于32位	✓

Esta API consulta o saldo da carteira YabandPay.

Dica

Somente contas de superadministrador do estabelecimento podem chamar esta API. Contas de operador e caixa não têm autorização para chamá-la.

Parâmetro	Tipo	Descrição	Obrigatório
user	String	UID da conta de superadministrador
sign	String	Signature	Obrigatório
method	String	v3.MerchantBalance	Obrigatório
time	Long	Timestamp	Obrigatório

Parameters

Parâmetro	Tipo	Descrição	Obrigatório
command	String	getBalance	Obrigatório
currency	String	Código da moeda ISO 4217, por exemplo, EUR ou CHF	Obrigatório
nonce_string	String	Cadeia aleatória com no máximo 32 caracteres	Obrigatório

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

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

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Response example:

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

Additional information:

Response parameter descriptions:

Parâmetro	Tipo	Descrição
user	String	UID da conta de superadministrador
time	String	Carimbo de data/hora atual
gateway_name	String	Nome da instituição
wallet_id	String	ID da carteira
currency	String	Código da moeda, ISO 4217
available	String	Saldo disponível
reserve	String	Saldo de reserva
usable	String	Valor disponível para uso, igual a vailable - reserve
deposit	String	Saldo congelado

Consultar saldo

Consultar saldo

Request parameters3

余额查询

Parâmetros

Signature example:

Request example:

Response example:

Additional information:

Response parameter descriptions: