Skip to main content
GET
Get simulation status

Authorizations

x-api-key
string
header
required

Path Parameters

simulation_id
string
required

The simulation_id returned by POST /sandbox/simulate/inbound

Response

Simulation found

Full simulation state including callback history.

simulation_id
string
required

Simulation identifier

rail
string
required

Payment rail (ach, wire, crypto)

operation
string
required

Operation type (inbound_posted, outbound_failed, etc.)

scenario
string
required

Scenario name (success_immediate, success_delayed, compliance_hold, etc.)

state
string
required

Current simulation state (accepted, settled, returned, rejected, failed)

organization_id
string
required

Organization that owns this simulation

amount
string
required

Amount as decimal string (e.g. "100.50")

currency
string
required

ISO 4217 currency code

created_at
string<date-time>
required

When the simulation was created

state_position
string

Sub-state for multi-step scenarios (e.g. post_hold)

awaiting_advance
boolean

Whether the simulation is paused waiting for a POST /advance call

account_id
string

Platform account ID (for fiat simulations)

wallet_id
string

Platform wallet ID (for crypto simulations)

trace_id
string

Caller-supplied trace ID

metadata
object

Caller-supplied metadata (informational only)

completed_at
string<date-time>

When the simulation reached a terminal state (omitted if still in progress)

callbacks
object[]

Callback delivery log ordered by scheduled_for ascending

advance_actions_available
string[]

Valid advance actions when awaiting_advance is true (e.g. ["release", "reject"])