---
title: "Simulate Transaction Flow in Sandbox"
method: PATCH
path: "/sandbox/transactions/{transactionId}/simulate"
tags: ["Transactions"]
---

# Simulate Transaction Flow in Sandbox

`PATCH /sandbox/transactions/{transactionId}/simulate`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/sandbox/transactions/{transactionId}/simulate`
- Auth: API key in header `Authorization`

This API will allow you to simulate through different transaction statuses in sandbox environment

## Path parameters

- `transactionId` string, required

## Request body

- SimulateTransactionRequest
  - `status` 'SCHEDULING' | 'SCHEDULED' | 'APPLIED' | 'FAILED' | 'CANCELLED' | 'RETURNED', required: New status that will be applied to the transaction

## Response `200`

Successful response

- SimulateTransactionResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` SimulateTransactionResponseData, required
    - `transactionId` string, required: Spinwheel generated Transaction Id.
    - `status` 'SCHEDULING' | 'SCHEDULED' | 'APPLIED' | 'FAILED' | 'CANCELLED' | 'RETURNED', required: status that got applied

## Other responses

- `400`: Bad request response
- `401`: Unauthorized response
- `404`: Not found response
- `500`: Internal server error response

---

[API](https://skmtc.dev/spinwheel/apis/pay.md) - [All operations](https://skmtc.dev/spinwheel/apis/pay/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/pay/revisions/58ba91f8ae13?raw)