Freeze an account program
Freezes an existing account program and its virtual accounts. 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.
Response
The account program freeze 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.