Loading…
Creates a withdrawal request for the authenticated user.
| Permission | Description |
|---|---|
payments.view_own | Access the payment system |
payments.withdraw | Request a withdrawal |
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| amount | decimal |
| Yes |
| Amount to withdraw |
| 100.00 |
| description | string | No | Description for the request (max 2000 chars) | "For expenses" |
{
"amount": 100.00,
"description": "For expenses"
}
Withdrawal request was created successfully.
The requested amount is held immediately: it is subtracted from
GET /payments/balance as soon as the row exists, without waiting for an admin to confirm
the payout. A second withdrawal request, and every purchase path, is therefore measured against the
reduced figure. The hold is released only if an operator rejects the request
(see PUT /payments/withdrawal/{payment}).
| Status | Description | Reference |
|---|---|---|
| 400 | Insufficient balance | Insufficient-balance error |
| 422 | Validation error | Validation error |
| 401 | Unauthorized | Authentication error |