Drain an account program
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.
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 program whose lifecycle is being simulated.
Body
Account program drain parameters
Fiat financial address to which the residual balance of every frozen account under the program is drained.
- IBAN
- UK Sort Code
- ABA
Response
The account program drain simulation acknowledgement
Resource type discriminator.
account_program_simulation Whether the simulation submission was successful.
Account program whose lifecycle is being simulated.
Account program lifecycle event submitted to the sandbox.
create, freeze, unfreeze, close, drain Payouts created by a drain event. Feed each id to POST /v1/simulations/payouts/{id}/send to settle. null for non-drain events.