Sign in
Simulations

Create an account program

Creates a Mock-US USD account program owned by the caller merchant. This endpoint is unavailable in live production.

post/v1/simulations/account_programs

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

labelstring required

Human-readable label for the account program.

type'fbo-program' | 'fbo-sponsored' required

Account program type.

Response

The account program creation simulation acknowledgement

type'account_program_simulation' required

Resource type discriminator.

successboolean required

Whether the simulation submission was successful.

account_program_idstring uuid required

Account program whose lifecycle is being simulated.

event'create' | 'freeze' | 'unfreeze' | 'close' | 'drain' required

Account program lifecycle event submitted to the sandbox.

payout_idsstring[] nullable required

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

Changes

Changed in 1 of the 38 revisions of this API.1