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

# Get inbound transfer simulation options for a Virtual Account

> Describe what a POST to this path would accept for this Virtual Account right now: whether an inbound transfer can be simulated, and with which `type` and `network` pairs. When `available` is false, `methods` is empty and `unavailableReason` says why. Sandbox / non-production only; returns 404 in production-live.



## OpenAPI

````yaml /api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.11.5-0001
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.13
    description: Sandbox
  - url: https://api.polygon.technology/v0.13
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication
  - name: Customers
    description: Customer management and KYC
  - name: CustomerTokens
    description: Customer-bound tokens for browser SDK calls
  - name: Wallets
    description: Embedded wallet association
  - name: Webhooks
    description: Webhook endpoints, signing secrets, and event delivery
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: Transfer
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: VirtualAccount
  - name: Counterparty
  - name: Withdrawal Request
  - name: ExternalAccount
  - name: Reference
  - name: DepositAddress
  - name: Indexer
    description: >-
      Read token balances, prices, and transaction history across EVM networks,
      Solana, and Tron. Indexer methods are webRPC calls: each is a `POST` with
      a JSON body, served at `/v1/{Service}/{Method}` on the API host rather
      than under the `/v0.13` base path. Authenticate with a publishable key in
      the `Api-Key` header, or with a bearer token from `POST /auth/token`.
paths:
  /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer:
    get:
      tags:
        - Sandbox
      summary: Get inbound transfer simulation options for a Virtual Account
      description: >-
        Describe what a POST to this path would accept for this Virtual Account
        right now: whether an inbound transfer can be simulated, and with which
        `type` and `network` pairs. When `available` is false, `methods` is
        empty and `unavailableReason` says why. Sandbox / non-production only;
        returns 404 in production-live.
      operationId: getVirtualAccountInboundTransferSimulation
      parameters:
        - name: virtualAccountId
          in: path
          required: true
          description: Virtual Account ID (`va_` prefix).
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateVaInboundTransferOptions'
              examples:
                Virtual Account not active:
                  summary: Virtual Account not active
                  value:
                    virtualAccountId: va_bztg5dcpfbec9s0jkq28d5meq3
                    available: false
                    unavailableReason: accountNotActive
                    methods: []
                    maximumAmount: '10'
                Simulation available:
                  summary: Simulation available
                  value:
                    virtualAccountId: va_bztg5dcpfbec9s0jkq28d5meq3
                    available: true
                    methods:
                      - type: bankUs
                        network: ach
                      - type: bankUs
                        network: wire
                      - type: bankIban
                        network: swift
                    maximumAmount: '10'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidVirtualAccountIDErrorResponse'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualAccountNotFoundErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
components:
  schemas:
    SimulateVaInboundTransferOptions:
      anyOf:
        - $ref: '#/components/schemas/SimulateVaInboundTransferAvailable'
        - $ref: '#/components/schemas/SimulateVaInboundTransferUnavailable'
      description: >-
        Response for GET /virtual-accounts/{id}/simulate/inbound-transfer: what
        a POST to the same path would accept for this Virtual Account right now.
    InvalidVirtualAccountIDErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - InvalidVirtualAccountID
        code:
          type: number
          enum:
            - 10201
        msg:
          type: string
          enum:
            - invalid virtual account id
        cause:
          type: string
    VirtualAccountNotFoundErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - VirtualAccountNotFound
        code:
          type: number
          enum:
            - 10200
        msg:
          type: string
          enum:
            - virtual account not found
        cause:
          type: string
    InternalErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - Internal
        code:
          type: number
          enum:
            - 10124
        msg:
          type: string
          enum:
            - internal error
        cause:
          type: string
    SimulateVaInboundTransferAvailable:
      type: object
      required:
        - virtualAccountId
        - available
        - methods
        - maximumAmount
      properties:
        virtualAccountId:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: The Virtual Account described (`va_` prefix).
        available:
          type: boolean
          enum:
            - true
          description: Always true on this shape.
        methods:
          type: array
          items:
            $ref: '#/components/schemas/SimulateVaInboundTransferMethod'
          minItems: 1
          description: The methods a POST accepts. Never empty.
        maximumAmount:
          allOf:
            - $ref: '#/components/schemas/decimalString'
          description: The largest `amount` a POST accepts (inclusive).
      description: The Virtual Account can be simulated against now.
      title: Simulation available
    SimulateVaInboundTransferUnavailable:
      type: object
      required:
        - virtualAccountId
        - available
        - unavailableReason
        - methods
        - maximumAmount
      properties:
        virtualAccountId:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: The Virtual Account described (`va_` prefix).
        available:
          type: boolean
          enum:
            - false
          description: Always false on this shape.
        unavailableReason:
          allOf:
            - $ref: '#/components/schemas/SimulateVaUnavailableReason'
          description: Why the Virtual Account cannot be simulated against.
        methods:
          type: array
          items:
            $ref: '#/components/schemas/SimulateVaInboundTransferMethod'
          maxItems: 0
          description: Always empty.
        maximumAmount:
          allOf:
            - $ref: '#/components/schemas/decimalString'
          description: The largest `amount` a POST accepts (inclusive).
      description: The Virtual Account cannot be simulated against now.
      title: Simulation unavailable
    typeId:
      type: string
      pattern: >-
        ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
      description: Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`.
      x-go-type: string
    SimulateVaInboundTransferMethod:
      type: object
      oneOf:
        - $ref: '#/components/schemas/SimulateVaBankUsMethod'
        - $ref: '#/components/schemas/SimulateVaBankIbanMethod'
      discriminator:
        propertyName: type
        mapping:
          bankUs: '#/components/schemas/SimulateVaBankUsMethod'
          bankIban: '#/components/schemas/SimulateVaBankIbanMethod'
      description: >-
        One way to simulate an inbound transfer: a `type` and `network` pair a
        POST to the same path accepts for this Virtual Account.
    decimalString:
      type: string
      description: >-
        Wire-safe decimal string for financial float values (USD amounts,
        percentages).
      x-go-type-import:
        path: github.com/shopspring/decimal
      x-go-type: decimal.Decimal
    SimulateVaUnavailableReason:
      type: string
      enum:
        - accountNotActive
        - accountNotProvisioned
        - notSupportedByProvider
      description: Why a Virtual Account cannot be simulated against right now.
    SimulateVaBankUsMethod:
      type: object
      required:
        - type
        - network
      properties:
        type:
          type: string
          enum:
            - bankUs
          description: The request's rail discriminator.
        network:
          allOf:
            - $ref: '#/components/schemas/SimulateVaBankUsNetwork'
          description: The network to send with `bankUs`.
      description: 'A `bankUs` method: one of the US networks.'
      title: US bank account method
    SimulateVaBankIbanMethod:
      type: object
      required:
        - type
        - network
      properties:
        type:
          type: string
          enum:
            - bankIban
          description: The request's rail discriminator.
        network:
          type: string
          enum:
            - swift
          description: The network to send with `bankIban`.
      description: 'A `bankIban` method: always `swift`.'
      title: International bank account method
    SimulateVaBankUsNetwork:
      type: string
      enum:
        - ach
        - wire
        - rtp
      description: >-
        Network for a `bankUs` (US domestic) inbound simulation. Not every rail
        is available on every Virtual Account; one whose provider does not offer
        the requested rail refuses the request.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````