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

# Fiat order status

> Current state of a fiat order, looked up by the `externalOrderUid` returned when you created it.

Statuses are normalised, so you get the same vocabulary regardless of which provider settled the payment.

This is the polling fallback. Prefer the session's completion webhook where you can receive one — it fires as soon as funds land.



## OpenAPI

````yaml /api-reference/openapi.json get /onramp/order-status
openapi: 3.1.0
info:
  title: Hypermid API
  description: >-
    Price and execute cross-chain swaps, read reference data and payer balances,
    and quote the fiat on-ramp. Quotes return an executable `transactionRequest`
    your frontend submits directly, so Hypermid never custodies the funds.


    Payments — `checkout`, `deposit`, and `withdrawal` sessions — and
    payment-link management are available through these merchant REST endpoints
    and the [`@hypermid/sdk`](https://docs.hypermid.io/sdk/payments) package.
    Payer-facing routes are intentionally omitted.
  version: 0.2.0
  contact: {}
servers:
  - url: https://server.hypermid.io
    description: Production — live keys (sk_live_…)
  - url: https://server.hypermid.io
    description: Sandbox — test keys (sk_test_…), testnets only
security: []
tags:
  - name: payments
    description: >-
      Create and read payment sessions, manage webhooks, and configure payout
      addresses with a secret partner key.
  - name: payment links
    description: >-
      Create, read, version, and revoke reusable checkout payment links with a
      secret partner key.
  - name: quote
    description: >-
      Route pricing for the orchestration product. Returns an executable
      `transactionRequest` your frontend submits directly, so Hypermid never
      custodies the funds.
  - name: status
    description: >-
      Resolve the state of a submitted swap or transfer. Two endpoints with
      different audiences — see each one's description before choosing.
  - name: catalog
    description: >-
      Reference data an integration needs to render a picker: supported chains
      and tokens, prices, routable connections, and fee configuration. A sandbox
      key sees only testnets here.
  - name: balances
    description: Read a payer wallet's token balances across supported chains.
  - name: onramp
    description: >-
      The fiat rail — card and bank payment for crypto, quoted and settled
      through our onramp partner. Requires per-partner onramp credentials on
      your account.
  - name: webhooks
    description: >-
      Events Hypermid sends TO you when a session completes. These are requests
      we make to your server, not endpoints you call.
paths:
  /onramp/order-status:
    get:
      tags:
        - onramp
      summary: Fiat order status
      description: >-
        Current state of a fiat order, looked up by the `externalOrderUid`
        returned when you created it.


        Statuses are normalised, so you get the same vocabulary regardless of
        which provider settled the payment.


        This is the polling fallback. Prefer the session's completion webhook
        where you can receive one — it fires as soon as funds land.
      operationId: OnrampController_orderStatus
      parameters:
        - name: uid
          required: true
          in: query
          description: The externalOrderUid returned by /onramp/checkout.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampOrderStatusResponseDto'
      security:
        - x-api-key: []
components:
  schemas:
    OnrampOrderStatusResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Normalized order status.
          enum:
            - waiting
            - processing
            - completed
            - failed
            - expired
            - canceled
        dstAmount:
          type: string
          description: Destination amount delivered, when known.
        message:
          type: string
          description: Present when the order was not found.
      required:
        - status
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Soft-auth read routes accept `x-api-key` with a publishable or partner
        key; money-moving routes require a secret partner key in `Authorization:
        Bearer`.

````