Diff for /documentation/guides/payments/cash_withdrawal.md
On this page, you can preview the modified document with the changes.
Note that the links within this diff are most likely broken because they are
relative to the original document or
point to another document that is not part of the changeset.
Cash balance withdrawal
A withdrawal is the process of paying out a user’s funds to their reference account.
How withdrawals work
Withdrawals can be processed for the share of the cash balance with the state
AVAILABLE_FOR_WITHDRAWAL. Consider this sell order example demonstrating the process:
- Once a sell order is successfully executed, the Investment API calculates the net amount after taxes and fees.
- A user’s cash balance is updated by the net amount and assigned the state
- After the order is settled funds are transferred to the user's cash account in our system, representing a funding event.
- The net amount is now
AVAILABLE_FOR_WITHDRAWAL, and therefore can be withdrawn.
The following flow diagram illustrates the withdrawal flow including all related withdrawal status changes, and cash balance updates:
Settlement of funds typically takes two business days.
How to implement Implementing withdrawals
Withdrawals require that a user is created, has an assigned reference bank account, and sufficient funds in their cash balance (e.g., from a sell order) that are not locked for other purposes such as re-investment.
Submitting a withdrawal request
To request a cash withdrawal, you can specify the cash amount and reference account when triggering a request by POST
After a successful withdrawals request, the sample response for the above will look as follows:
You will also receive a withdrawal
NEW webhook with the exactly same payload.
Once all relevant payment checks have been passed and payment instruction forwarded to payment partner, the withdrawal transitions into status
PROCESSING and you will receive a withdrawal event via webhook.
Afterwards, the withdrawal gets executed and confirmed at our payment partner and you will receive a withdrawal
Cash balance update
Based on the withdrawal status, you will also receive a cash balance updated event via webhook. Depending on these statuses, the fields inside the cash balance update can be interpreted as follows:
|Total cash amount held by the account group
|Maximum cash amount that can be withdrawn
Assuming that the user has a settled sell order with EUR 200,00 (following fees and taxes), intended for withdrawal, the cash balance updates for the above withdrawal look as follows.
Example of the cash balance before the withdrawal request
Example update for withdrawal
Example update for withdrawal
There is no cash balance update for a nominal buy order with status
PROCESSING, because all fields remain unaffected and do not change.
### Cancelling a withdrawal
It is possible to cancel a withdrawal.
The prerequisite for this is that they have the status
To cancel an existing withdrawal, call the cancellation endpoint with the appropriate withdrawal ID, using
Was this page helpful?