Simulations

Drain an operating account

Changed on

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

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/simulations/accounts/{id}/drain
  • Auth
    HTTP bearer

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": "aba",
    "routing_number": "110000000",
    "account_number": "000123456789",
    "account_holder_name": "Acme Sandbox Ltd.",
    "account_type": "checking"
  }
}

Response

The account drain simulation acknowledgement

type'account_simulation' required

Resource type discriminator.

account_idstring uuid required

Account whose lifecycle is being simulated.

payout_idstring uuid required

Payout created by the drain. Feed to POST /v1/simulations/payouts/{id}/send to settle.

Changes