Skip to main content
POST
JavaScript

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 close parameters

reason
enum<string>
required

Reason for closing the account program.

Available options:
aml_risk_fraud,
client_request

Response

200 - application/json

The account program close simulation acknowledgement

type
enum<string>
required

Resource type discriminator.

Available options:
account_program_simulation
success
boolean
required

Whether the simulation submission was successful.

account_program_id
string<uuid>
required

Account program whose lifecycle is being simulated.

event
enum<string>
required

Account program lifecycle event submitted to the sandbox.

Available options:
create,
freeze,
unfreeze,
close,
drain
payout_ids
string<uuid>[] | null
required

Payouts created by a drain event. Feed each id to POST /v1/simulations/payouts/{id}/send to settle. null for non-drain events.