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

# Get autoramp quote preview

> Price a prospective autoramp knowing only the currencies — before a recipient
wallet or bank account is selected. Prices identically to `getAutorampQuote`;
banking fees assume the destination currency's default payout rail (USD→ACH,
EUR→SEPA, GBP→FPS; see `assumed_payout_rail` in the response). The result is an
estimate and cannot be submitted; fetch a signed quote once a recipient is chosen.



## OpenAPI

````yaml /spec.yaml get /autoramps/quotes-preview
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: 1.0-16670
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:
  /autoramps/quotes-preview:
    get:
      tags:
        - Autoramp
      summary: Get autoramp quote preview
      description: >-
        Price a prospective autoramp knowing only the currencies — before a
        recipient

        wallet or bank account is selected. Prices identically to
        `getAutorampQuote`;

        banking fees assume the destination currency's default payout rail
        (USD→ACH,

        EUR→SEPA, GBP→FPS; see `assumed_payout_rail` in the response). The
        result is an

        estimate and cannot be submitted; fetch a signed quote once a recipient
        is chosen.
      operationId: getAutorampQuotePreview
      parameters:
        - deprecated: false
          description: >-
            Optional sub-partner UUID, if provided, the quote preview is scoped
            to the sub-partner
          explode: true
          in: header
          name: X-SUB-PARTNER-ID
          required: false
          schema:
            type: string
        - deprecated: false
          description: The customer id
          explode: true
          in: query
          name: customer_id
          required: true
          schema:
            format: uuid
            type: string
        - deprecated: false
          description: The source currency code
          explode: true
          in: query
          name: source_currency_code
          required: true
          schema:
            maxLength: 32
            type: string
        - deprecated: false
          description: The source currency chain
          explode: true
          in: query
          name: source_currency_chain
          required: false
          schema:
            $ref: '#/components/schemas/Blockchain'
        - deprecated: false
          description: The destination currency code
          explode: true
          in: query
          name: destination_currency_code
          required: true
          schema:
            maxLength: 32
            type: string
        - deprecated: false
          description: The destination currency chain
          explode: true
          in: query
          name: destination_currency_chain
          required: false
          schema:
            $ref: '#/components/schemas/Blockchain'
        - deprecated: false
          description: The source amount. Provide exactly one of amount_in / amount_out.
          explode: true
          in: query
          name: amount_in
          required: false
          schema:
            default: null
            format: decimal
            type: string
        - deprecated: false
          description: >-
            The destination amount. Provide exactly one of amount_in /
            amount_out.
          explode: true
          in: query
          name: amount_out
          required: false
          schema:
            default: null
            format: decimal
            type: string
        - deprecated: false
          description: Price against this fee profile; resolved automatically when omitted
          explode: true
          in: query
          name: fee_profile_id
          required: false
          schema:
            default: null
            format: uuid
            type: string
        - deprecated: false
          description: Is this a third party autoramp (defaults to false)
          explode: true
          in: query
          name: is_third_party
          required: false
          schema:
            default: null
            type: boolean
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiAutorampQuotePreview'
          description: Preview successful
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Bad Request
        '401':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Unauthorized
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Forbidden
        '404':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Not Found
        '500':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Internal Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Blockchain:
      description: |
        Blockchain

        A type of blockchain
      enum:
        - Solana
        - Ethereum
        - Polygon
        - Arbitrum
        - Base
        - Stellar
        - Citrea
        - Plasma
        - Avalanche
        - Moca
        - Tempo
        - Tron
        - Bsc
      type: string
    ApiAutorampQuotePreview:
      description: |
        Autoramp Quote Preview

        A recipient-free pricing preview, shaped like a signed quote but not
        submittable: no quote_id, signature, or validity window.
      properties:
        amount_in:
          $ref: '#/components/schemas/Amount'
        amount_out:
          $ref: '#/components/schemas/Amount'
        assumed_payout_rail:
          $ref: '#/components/schemas/PaymentNetwork'
        customer_id:
          description: The customer id
          format: uuid
          type: string
        destination_currency:
          $ref: '#/components/schemas/Currency'
        fee:
          $ref: '#/components/schemas/Fee'
        fee_profile_id:
          description: The fee profile this preview was priced against
          format: uuid
          type: string
        fee_settlement:
          $ref: '#/components/schemas/FeeSettlement'
        rate:
          description: The rate (destination per 1 source)
          format: decimal
          type: string
        source_currency:
          $ref: '#/components/schemas/Currency'
      required:
        - source_currency
        - destination_currency
        - customer_id
        - amount_in
        - amount_out
        - rate
        - fee
        - fee_settlement
        - fee_profile_id
      title: ApiAutorampQuotePreview
      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
    Amount:
      description: |
        An amount of money
      example:
        amount: '100.5'
        currency:
          code: USD
          type: Fiat
      properties:
        amount:
          description: The amount, a decimal number
          format: decimal
          type: string
        currency:
          $ref: '#/components/schemas/Currency'
      required:
        - amount
        - currency
      title: Amount
      type: object
    PaymentNetwork:
      description: |
        PaymentNetwork

        A payment network
      enum:
        - Sepa
        - Swift
        - Fps
        - Chats
        - Ach
        - Wire
        - Rtp
        - Fednow
        - Pix
        - Spei
        - AfricanBankTransfer
        - MobileMoney
        - Chaps
      type: string
    Currency:
      anyOf:
        - $ref: '#/components/schemas/Currency_Crypto'
        - $ref: '#/components/schemas/Currency_Fiat'
      description: |
        Currency

        Can be either crypto or fiat
      discriminator:
        mapping:
          Crypto:
            $ref: '#/components/schemas/Currency_Crypto'
          Fiat:
            $ref: '#/components/schemas/Currency_Fiat'
        propertyName: type
      type: object
    Fee:
      description: |
        Fee

        The fee for a given currency pair
      properties:
        banking_fee:
          $ref: '#/components/schemas/Amount'
        banking_fee_network:
          $ref: '#/components/schemas/PaymentNetwork'
        deducted_fee:
          allOf:
            - $ref: '#/components/schemas/Amount'
            - deprecated: true
              description: >-
                The amount of the fee that was deducted immediately and charged
                to the end customer. This is deprecated and will be removed in
                the future. Use transaction_fee instead.
          deprecated: true
          description: >-
            The amount of the fee that was deducted immediately and charged to
            the end customer. This is deprecated and will be removed in the
            future. Use transaction_fee instead.
        iron_fee:
          $ref: '#/components/schemas/Amount'
        iron_fee_settlement:
          $ref: '#/components/schemas/FeeSettlement'
        network_fee:
          $ref: '#/components/schemas/Amount'
        network_fees:
          deprecated: true
          description: The network fees in source currency
          items:
            $ref: '#/components/schemas/NetworkFee'
          type: array
        network_fees_with_settlement:
          description: The network fees with settlement
          items:
            $ref: '#/components/schemas/NetworkFeeWithSettlement'
          type: array
        partner_fee:
          $ref: '#/components/schemas/Amount'
        partner_fees:
          description: The partner fees
          items:
            $ref: '#/components/schemas/PartnerFee'
          type: array
        total_fee:
          $ref: '#/components/schemas/Amount'
        transaction_fee:
          $ref: '#/components/schemas/Amount'
      required:
        - total_fee
        - iron_fee
        - partner_fee
        - network_fees
        - network_fees_with_settlement
        - partner_fees
        - transaction_fee
        - banking_fee
        - network_fee
      title: Fee
      type: object
    FeeSettlement:
      description: |
        Fee Settlement

        The settlement type for the fee
      enum:
        - deductedImmediately
        - settledLater
      type: string
    Currency_Crypto:
      allOf:
        - properties:
            type:
              enum:
                - Crypto
              example: Crypto
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/Crypto'
      description: |
        Currency

        Can be either crypto or fiat
    Currency_Fiat:
      allOf:
        - properties:
            type:
              enum:
                - Fiat
              example: Fiat
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/Fiat'
      description: |
        Currency

        Can be either crypto or fiat
    NetworkFee:
      anyOf:
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
        - $ref: '#/components/schemas/NetworkFee_Amount'
      description: >
        Network Fee


        The network fee for a given currency. This is deprecated and will be
        removed in the future. Use NetworkFeeWithSettlement instead.
      discriminator:
        mapping:
          AchIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          AchOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          CitreaGas:
            $ref: '#/components/schemas/NetworkFee_Amount'
          EthereumGas:
            $ref: '#/components/schemas/NetworkFee_Amount'
          RailFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SepaIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SepaOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SolanaTransactionFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          StellarTransactionFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SwiftIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SwiftOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          WireIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          WireOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
        propertyName: type
      type: object
    NetworkFeeWithSettlement:
      description: |
        Network Fee with Settlement

        The network fee with settlement for a given currency
      properties:
        fee_amount:
          $ref: '#/components/schemas/Amount'
        fee_type:
          $ref: '#/components/schemas/NetworkFeeType'
        settlement:
          $ref: '#/components/schemas/FeeSettlement'
      required:
        - fee_type
        - fee_amount
      title: NetworkFeeWithSettlement
      type: object
    PartnerFee:
      description: |
        Partner Fee

        A partner fee
      properties:
        fee:
          $ref: '#/components/schemas/Amount'
        label:
          description: The label of the partner fee
          type: string
        settlement:
          $ref: '#/components/schemas/FeeSettlement'
      required:
        - label
        - fee
        - settlement
      title: PartnerFee
      type: object
    Crypto:
      description: A cryptocurrency
      example:
        blockchain: Solana
        token: USDC
      properties:
        blockchain:
          $ref: '#/components/schemas/Blockchain'
        token:
          description: The ticker of the token e.g. 'USDC'
          type: string
      required:
        - token
        - blockchain
      title: Crypto
      type: object
    Fiat:
      description: A fiat currency
      example:
        code: USD
      properties:
        code:
          description: The code of the currency e.g. 'USD'
          type: string
      required:
        - code
      title: Fiat
      type: object
    NetworkFee_Amount:
      allOf:
        - properties:
            type:
              enum:
                - SwiftOut
              example: SwiftOut
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/Amount'
      description: >
        Network Fee


        The network fee for a given currency. This is deprecated and will be
        removed in the future. Use NetworkFeeWithSettlement instead.
    NetworkFeeType:
      description: |
        Network Fee Type

        The type of network fee
      enum:
        - SepaIn
        - SepaOut
        - EthereumGas
        - CitreaGas
        - SolanaTransactionFee
        - StellarTransactionFee
        - PolygonGas
        - BaseGas
        - AvalancheGas
        - TronGas
        - BscGas
        - RailFee
        - AchIn
        - AchOut
        - WireIn
        - WireOut
        - SwiftIn
        - SwiftOut
        - FpsIn
        - FpsOut
        - ChapsIn
        - ChapsOut
        - RtpIn
        - RtpOut
        - FednowIn
        - FednowOut
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````