API REFERENCE

Levantamento

YabandPay documentation·Atualizado em 26 de out. de 2026

Parâmetros

Parameter	Type	Descrição	Obrigatório
data.command	string	payout	✓
data.amount	number	提款金额，2位小数，例如19.99	✓
data.currency	string	货币代码，ISO 4217，例如EUR，CHF	✓
data.reference	string	备注	✓
data.notify_url	string	异步通知地址	✓
data.nonce_string	string	随机字符串，不长于32位	✓

Esta API transfere fundos do saldo da carteira YabandPay.

Dica

O valor do saque não pode exceder o saldo disponível para uso (utilizável).

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	Obrigatório
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	payout	Obrigatório
amount	String	Valor do saque com 2 casas decimais, por exemplo, 19.99	Obrigatório
currency	String	Código da moeda ISO 4217, como EUR ou CHF	Obrigatório
reference	String	Remarks	Obrigatório
notify_url	String	URL de notificação assíncrona	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

"amount=100.01&command=payout&currency=EUR&method=v3.MerchantBalance&nonce_string=2yx20x4c6dswedikxs&notify_url=https://www.yabandpay.com/notify&reference=456789&time=1708482257&user=036870"

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

{
    "user": "036870",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.MerchantBalance",
    "time": 1708482257,
    "data": {
        "command": "payout",
        "nonce_string": "2yx20x4c6dswedikxs",
        "amount": 100.01,
        "currency": "EUR",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "036870",
        "time": 1708482257,
        "gateway_name": "YabandPay",
        "payout_id": "0594bf99-fce7-3784-28f7-e8e76ad01989",
        "currency": "EUR",
        "amount": "100.01",
        "reference": "456789",
        "notify_url": "https://www.yabandpay.com/notify",
        "state": "awaiting approval"
    },
    "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 da carteira
payout_id	String	número do pedido de saque
currency	String	Código da moeda, ISO 4217
amount	String	Valor do saque
reference	String	Remarks
notify_url	String	URL de notificação assíncrona
state	String	Status do pedido. Atualmente há 6 status: awaiting approval, pending, failed, completed, declined, cancelled