Sign in
Simulations

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.

post/v1/simulations/accounts/{id}/drain

Path parameters

idstring uuid required

ID of the account whose lifecycle is being simulated.

Headers

Idempotency-Keystring required

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.

Request body

Example request

{
  "destination": {
    "type": "iban",
    "iban": "DE89370400440532013000",
    "account_holder_name": "Acme Sandbox Ltd.",
    "bic": "COBADEFFXXX"
  }
}

Response

The account drain simulation acknowledgement

type'account_simulation' required

Resource type discriminator.

successboolean required

Whether the simulation submission was successful.

account_idstring uuid required

Account whose lifecycle is being simulated.

event'create' | 'freeze' | 'unfreeze' | 'close' | 'drain' required

Account lifecycle event submitted to the sandbox.

payout_idstring uuid nullable required

Payout created by a drain event. Feed to POST /v1/simulations/payouts/{id}/send to settle. null for non-drain events.

Changes

Changed in 1 of the 38 revisions of this API.1