Decrease balance
BalanceOut¶
Description: Subtracts a withdrawal from the user's account balance. Only negative values are accepted for the amount.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| login | int | Yes | User login ID from whose balance to withdraw |
| amount | double | Yes | Negative amount to withdraw (e.g., -100.0) |
| comment | string | No | Optional comment (default: "Finance") |
| order | int | No | Optional order ID for this balance operation, if set will be modify operation |
Request Example¶
{
"login": 123456,
"amount": -250.00,
"comment": "Manual withdrawal"
}
Response Parameters¶
| Name | Type | Description |
|---|---|---|
| data | string | Returns "OK" if successful |
Response Example¶
{
"data": "OK"
}
⚠️ If a positive amount is passed, the request will be rejected due to validation rules:
{ "error": "INVALID_DATA", "message": "Amount must be less than to 0" }