> ## 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.

# Simulate inbound transfer on a Deposit Address

> Simulate an inbound stablecoin (blockchain) transfer against a Deposit
Address, for testing webhook and reconciliation flows. Sandbox /
non-production only; returns 404 in production-live. The amount currency
and network are resolved server-side from the Deposit Address; the
response fields are documented on the corresponding schema.



## OpenAPI

````yaml /api-reference/openapi.yaml post /deposit-addresses/{depositAddressId}/simulate
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.05.28-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.9
    description: Sandbox
  - url: https://api.polygon.technology/v0.9
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via FrontEgg
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: Webhook
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: Simulation
paths:
  /deposit-addresses/{depositAddressId}/simulate:
    post:
      tags:
        - Simulation
      summary: Simulate inbound transfer on a Deposit Address
      description: |-
        Simulate an inbound stablecoin (blockchain) transfer against a Deposit
        Address, for testing webhook and reconciliation flows. Sandbox /
        non-production only; returns 404 in production-live. The amount currency
        and network are resolved server-side from the Deposit Address; the
        response fields are documented on the corresponding schema.
      operationId: simulateDepositAddressInbound
      parameters:
        - in: path
          name: depositAddressId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKeyHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositAddressSimulationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositAddressSimulationResponse'
          description: The request has succeeded.
components:
  parameters:
    IdempotencyKeyHeader:
      description: >-
        Required on POST and PUT requests. Use a unique value per logical
        mutation attempt, for example a UUID.
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
  schemas:
    DepositAddressSimulationRequest:
      description: Request body for POST /deposit-addresses/{id}/simulate.
      properties:
        amount:
          $ref: '#/components/schemas/BlockchainInAmountRequest'
      required:
        - amount
      type: object
    DepositAddressSimulationResponse:
      description: >-
        Response for POST /deposit-addresses/{id}/simulate. No `rail` - the
        route

        implies blockchain_in.
      properties:
        amount:
          $ref: '#/components/schemas/BlockchainInAmountResponse'
        depositAddressId:
          type: string
        network:
          $ref: '#/components/schemas/BlockchainInNetwork'
        status:
          enum:
            - submitted
          type: string
        submittedAt:
          type: string
          format: date-time
        transactionHash:
          description: Synthetic on-chain transaction hash for webhook correlation.
          type: string
      required:
        - depositAddressId
        - amount
        - network
        - transactionHash
        - status
        - submittedAt
      type: object
    BlockchainInAmountRequest:
      description: >-
        Stablecoin amount carried in the deposit-address simulation request:
        value

        only. The currency is resolved server-side from the DA's source_asset.
      properties:
        value:
          allOf:
            - $ref: '#/components/schemas/int64String'
          description: Stablecoin amount in cents. > 0 and <= 100000.
      required:
        - value
      type: object
    BlockchainInAmountResponse:
      description: >-
        Stablecoin amount echoed back in the deposit-address simulation
        response:

        value + currency.
      properties:
        currency:
          $ref: '#/components/schemas/BlockchainInCurrency'
        value:
          allOf:
            - $ref: '#/components/schemas/int64String'
          description: Stablecoin amount in cents.
      required:
        - currency
        - value
      type: object
    BlockchainInNetwork:
      description: Blockchain network for inbound blockchain transfers.
      enum:
        - BASE
        - ETHEREUM
        - INK
        - SOLANA
        - SUI
      type: string
    int64String:
      description: Wire-safe integer string for fiat amounts within int64 range.
      type: string
      x-go-type: types.Int64String
      x-go-type-import:
        path: github.com/0xPolygon/bpn-api/types
    BlockchainInCurrency:
      description: Stablecoin currency code accepted for inbound blockchain transfers.
      enum:
        - USDC
        - USDT
        - USAT
      type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````