Simulations

Drain an account program

Changed on

Creates outbound payouts that drain the residual balance of every frozen account under the program to the provided destination. The program must be frozen. Every returned payout_ids[i] must be settled via POST /v1/simulations/payouts/{id}/send for the program balance to reach zero. This endpoint is unavailable in live production.

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

Request

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

Path parameters

idstring uuid required

ID of the account program 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 program drain simulation acknowledgement

type'account_program_simulation' required

Resource type discriminator.

account_program_idstring uuid required

Account program whose lifecycle is being simulated.

payout_idsstring[] required

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

Changes