Skip to main content
POST
/
sandbox
/
simulations
/
{simulation_id}
/
advance
Advance a paused simulation
curl --request POST \
  --url https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "action": "release",
  "reason_code": "R10"
}
'
{
  "simulation_id": "sim_hold_001",
  "previous_state": "compliance_hold",
  "new_state": "release",
  "callbacks_scheduled": 1
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
simulation_id
string
required

The simulation_id returned by POST /sandbox/simulate/inbound

Body

application/json
​
action
string
required

The action to take. Valid values depend on the scenario:

  • compliance_hold: "release" | "reject"
  • manual_review: "approve" | "reject"
  • unconfirmed: "confirm" | "expire"
Example:

"release"

​
reason_code
string

Optional reason code for the action (e.g. R10 for ACH return).

Example:

"R10"

Response

Simulation advanced successfully

​
simulation_id
string
required

The simulation that was advanced.

Example:

"sim_01HXYZ"

​
previous_state
string
required

The state position before advancing (e.g., "compliance_hold").

Example:

"compliance_hold"

​
new_state
string
required

The state position after advancing (e.g., "release").

Example:

"release"

​
callbacks_scheduled
integer
required

Number of new callbacks scheduled by this advance action.

Example:

1