API REFERENCE

Withdrawal

YabandPay documentation·Updated Oct 26, 2026

This API withdraws funds from the YabandPay wallet balance.

Tip

The withdrawal amount must not exceed the spendable balance (usable).

Only merchant super administrator accounts can call this API. Operator and cashier accounts are not authorized to call it.

Parameter	Type	Description	Required
user	String	UID of the super administrator account	Required
sign	String	Signature	Required
method	String	v3.MerchantBalance	Required
time	Long	Timestamp	Required

Parameters

Parameter	Type	Description	Required
command	String	payout	Required
amount	String	Withdrawal amount with 2 decimal places, for example, 19.99	Required
currency	String	ISO 4217 currency code, such as EUR or CHF	Required
reference	String	Remarks	Required
notify_url	String	Asynchronous notification URL	Required
nonce_string	String	Random string, no longer than 32 characters	Required

Signature example:

Sorted parameters concatenated into a URL-style query string

"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

The resulting signature is:

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

Parameter	Type	Description
user	String	UID of the super administrator account
time	String	Current timestamp
gateway_name	String	Wallet institution name
payout_id	String	payout order number
currency	String	Currency code, ISO 4217
amount	String	Withdrawal amount
reference	String	Remarks
notify_url	String	Asynchronous notification URL
state	String	Order status. There are currently 6 statuses: awaiting approval, pending, failed, completed, declined, cancelled