> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iron.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Update sandbox transaction state

> Updates the state of a sandbox transaction for testing purposes



## OpenAPI

````yaml /spec.yaml put /sandbox/transaction/{id}/state
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: 1.0-17078
servers:
  - url: https://api.sandbox.iron.xyz/api
security: []
tags:
  - description: >-
      Wallet and bank account registration


      Every wallet address that interacts with Iron must be registered (linked)
      to a customer **before** it can be used in any flow — onramp, offramp, or
      swap. This is a regulatory requirement under the **Travel Rule**, which
      obliges Virtual Asset Service Providers to exchange originator and
      beneficiary information for crypto transfers.


      Iron supports two wallet types:


      - **Self-hosted wallets** — the customer controls the private key.
      Registration requires a signed proof-of-ownership message.

      - **Hosted wallets** — the wallet is custodied by another VASP (e.g.
      Coinbase, Kraken). Registration requires the VASP's DID so Iron can
      exchange travel-rule data with the custodian.


      Similarly, fiat bank accounts must be registered before they can receive
      offramp payouts.
    name: Addresses
  - description: Operations on Autoramp
    name: Autoramp
  - description: Operations on Chronicle collateral
    name: ChronicleCollateral
  - description: Operations on Currencies
    name: Currencies
  - description: Operations on Customers
    name: Customer
  - description: Operations on Exchange Rate
    name: ExchangeRate
  - description: Operations on Fee Profiles
    name: FeeProfiles
  - description: Operations for Sandbox Testing
    name: Sandbox
  - description: Operations on SSE
    name: Sse
  - description: Operations on Terms and Conditions
    name: TermsAndConditions
  - description: Operations on Webhooks
    name: Webhooks
paths:
  /sandbox/transaction/{id}/state:
    put:
      tags:
        - Sandbox
      summary: Update sandbox transaction state
      description: Updates the state of a sandbox transaction for testing purposes
      operationId: updateSandboxTransactionState
      parameters:
        - deprecated: false
          description: a UUID ensuring the state update operation is only processed once
          explode: true
          in: header
          name: IDEMPOTENCY-KEY
          required: true
          schema:
            type: string
        - deprecated: false
          description: the ID of the ramp transaction to update
          explode: true
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - $ref: '#/components/parameters/XApiVersion'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/UpdateRampTransactionStateParams'
        description: Parameters required to update the ramp transaction state
        required: true
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/SandboxSandboxTransaction'
          description: ''
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: ''
        '401':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: ''
        '404':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: ''
        '500':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: ''
      security:
        - ApiKeyAuth: []
components:
  parameters:
    XApiVersion:
      description: >-
        Selects the API version for this request, as an ISO date (`YYYY-MM-DD`).
        Omit to use the default version (`2025-03-13`). Supported versions:
        2025-03-13, 2026-07-01.
      in: header
      name: X-API-Version
      required: false
      schema:
        type: string
  schemas:
    UpdateRampTransactionStateParams:
      properties:
        state:
          $ref: '#/components/schemas/SandboxTransactionState'
      required:
        - state
      title: UpdateRampTransactionStateParams
      type: object
    SandboxSandboxTransaction:
      properties:
        amount_in:
          description: The amount deposited
          format: decimal
          type: string
        amount_out:
          description: The amount to be paid out
          format: decimal
          type: string
        autoramp_id:
          description: The autoramp ID used
          format: uuid
          type: string
        created_at:
          description: When the transaction was created
          format: date-time
          type: string
        currency_in:
          description: The input currency
          type: string
        currency_out:
          description: The output currency
          type: string
        customer_id:
          description: The customer ID
          format: uuid
          type: string
        id:
          description: The ID of the created ramp transaction
          format: uuid
          type: string
        state:
          description: The initial state
          type: string
      required:
        - id
        - autoramp_id
        - amount_in
        - currency_in
        - amount_out
        - currency_out
        - customer_id
        - state
        - created_at
      title: SandboxSandboxTransaction
      type: object
    ApiError:
      description: |-
        Standard error response returned to API clients for server errors.
        Includes a trace_id that clients can reference when reporting issues.
      properties:
        message:
          description: Human-readable error message
          type: string
        trace_id:
          description: Trace ID that can be used to look up request details in logs
          type: string
      required:
        - message
        - trace_id
      title: ApiError
      type: object
    SandboxTransactionState:
      enum:
        - Pending
        - Completed
        - Failed
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````