Skip to main content
POST
Drain an account program

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
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.

Path Parameters

id
string<uuid>
required

ID of the account program whose lifecycle is being simulated.

Body

application/json

Account program drain parameters

destination
IBAN · object
required

Fiat financial address to which the residual balance of every frozen account under the program is drained.

Example:

Response

200 - application/json

The account program drain simulation acknowledgement

type
enum<string>
required

Resource type discriminator.

Available options:
account_program_simulation
account_program_id
string<uuid>
required

Account program whose lifecycle is being simulated.

payout_ids
string<uuid>[]
required

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