Drain an operating account
Creates an outbound payout that drains the residual balance of a frozen operating (DDA) account to the provided destination. The returned payout_id must be settled via POST /v1/simulations/payouts/{id}/send for the account balance to reach zero. This endpoint is unavailable in live production.
Authorizations
Bearer token for authentication with Augustus Banking API
Headers
Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.
Path Parameters
ID of the account whose lifecycle is being simulated.
Body
Account drain parameters
Fiat financial address to which the residual balance of the frozen account is drained.
- IBAN
- UK Sort Code
- ABA
Response
The account drain simulation acknowledgement
Resource type discriminator.
account_simulation Whether the simulation submission was successful.
Account whose lifecycle is being simulated.
Account lifecycle event submitted to the sandbox.
create, freeze, unfreeze, close, drain Payout created by a drain event. Feed to POST /v1/simulations/payouts/{id}/send to settle. null for non-drain events.