End Simulation

POST

/api/simulations/:external_id/end

End a simulation. Freezes the simulation so its virtual clock can no longer be advanced. The simulation and its isolated objects remain readable for inspection.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

Response

Successful Response

idstring

account_idstring

virtual_clockdatetime

start_timedatetime

statusstring

descriptionstring or null

created_atdatetime

expires_atdatetime

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/simulations/external_id/end \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "sim-123e4567-e89b-12d3-a456-426614174000",
3	"account_id": "acc-987f6543-e21b-45d6-b789-123456789abc",
4	"virtual_clock": "2024-01-15T09:30:00Z",
5	"start_time": "2024-01-10T08:00:00Z",
6	"status": "ended",
7	"description": "Simulation ended and frozen for inspection.",
8	"created_at": "2024-01-10T07:55:00Z",
9	"expires_at": "2024-02-10T07:55:00Z"
10	}