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

# Get On-Ramp Status

> Check the status of a fiat on-ramp order

Returns the current status of a fiat-to-crypto on-ramp order.

<ParamField query="orderUid" type="string" required>
  The order UID returned from the checkout endpoint.
</ParamField>

<ResponseExample>
  ```json 200 Completed theme={"system"}
  {
    "data": {
      "orderUid": "ord_abc123def456",
      "status": "COMPLETED",
      "fiatCurrency": "USD",
      "fiatAmount": 100,
      "cryptoAsset": "ETH",
      "cryptoAmount": "0.029615",
      "chainId": 1,
      "walletAddress": "0xYourAddress",
      "txHash": "0xOnrampTxHash",
      "paymentMethod": "credit_card",
      "createdAt": 1711234578,
      "completedAt": 1711234878
    },
    "error": null,
    "meta": {
      "requestId": "s9b0c1d2-e3f4-5678-2345-789012345678",
      "timestamp": 1711234880,
      "rateLimit": {
        "limit": 2000,
        "remaining": 1981,
        "reset": 1711234927
      }
    }
  }
  ```

  ```json 200 Pending theme={"system"}
  {
    "data": {
      "orderUid": "ord_abc123def456",
      "status": "PAYMENT_RECEIVED",
      "fiatCurrency": "USD",
      "fiatAmount": 100,
      "cryptoAsset": "ETH",
      "cryptoAmount": null,
      "chainId": 1,
      "walletAddress": "0xYourAddress",
      "txHash": null,
      "paymentMethod": "credit_card",
      "createdAt": 1711234578,
      "completedAt": null
    },
    "error": null,
    "meta": {
      "requestId": "t0c1d2e3-f4a5-6789-3456-890123456789",
      "timestamp": 1711234680,
      "rateLimit": {
        "limit": 2000,
        "remaining": 1980,
        "reset": 1711234727
      }
    }
  }
  ```
</ResponseExample>

### Status Values

| Status             | Description                                         |
| ------------------ | --------------------------------------------------- |
| `CREATED`          | Checkout session created, waiting for user action   |
| `PENDING`          | Payment is being processed                          |
| `PAYMENT_RECEIVED` | Fiat payment confirmed, crypto transfer in progress |
| `CRYPTO_SENT`      | Crypto transaction submitted to the blockchain      |
| `COMPLETED`        | Order fully completed                               |
| `FAILED`           | Order failed                                        |
| `REFUNDED`         | Payment was refunded                                |
| `EXPIRED`          | Checkout session expired                            |

<CodeGroup>
  ```typescript TypeScript theme={"system"}
  const status = await client.getOnrampStatus({
    orderUid: "ord_abc123def456",
  });

  console.log("Status:", status.data.status);

  if (status.data.status === "COMPLETED") {
    console.log("Received:", status.data.cryptoAmount, status.data.cryptoAsset);
    console.log("Tx:", status.data.txHash);
  }
  ```

  ```bash cURL theme={"system"}
  curl "https://api.hypermid.io/v1/onramp/status?orderUid=ord_abc123def456" \
    -H "X-API-Key: your-api-key"
  ```

  ```go Go theme={"system"}
  req, _ := http.NewRequest("GET",
      "https://api.hypermid.io/v1/onramp/status?orderUid=ord_abc123def456", nil)
  req.Header.Set("X-API-Key", "your-api-key")
  resp, _ := http.DefaultClient.Do(req)
  ```
</CodeGroup>


## OpenAPI

````yaml GET /v1/onramp/status
openapi: 3.0.3
info:
  title: Hypermid Partner API
  version: 1.0.0
  description: >-
    Cross-chain swap aggregator API. Supports 30+ EVM chains, Solana, Bitcoin,
    Sui, and Near Intents chains (NEAR, TON, Tron, XRP, etc.).


    ## Authentication

    Pass your API key via the `X-API-Key` header. Public endpoints work without
    a key (anonymous tier). Partner endpoints (`/v1/partner/*`) require a valid
    key.


    ## Rate Limits

    - **Anonymous**: 30 requests/minute (per IP)

    - **Partner (authenticated)**: 100 requests/minute (per API key)


    These limits are designed for human-driven widget usage and mirror our
    upstream aggregator (LiFi) limits to prevent any single user from exhausting
    shared quota.


    Rate limit info is returned in `meta.rateLimit` on every response.


    ## Response Envelope

    All responses follow the shape:

    ```json

    { "data": <T | null>, "error": <{ code, message, details? } | null>, "meta":
    { "requestId", "timestamp", "rateLimit?" } }

    ```
  contact:
    name: Hypermid
    url: https://hypermid.io
servers:
  - url: https://api.hypermid.io
    description: Production
security:
  - ApiKeyAuth: []
  - {}
tags:
  - name: Swap
    description: Cross-chain swap quoting, routing, status, and reference data
  - name: Execute
    description: Transaction execution and deposit management for Near Intents swaps
  - name: On-Ramp
    description: Fiat-to-crypto on-ramp via RampNow
  - name: Partner
    description: Partner account, analytics, and webhook management (requires X-API-Key)
  - name: Tracking
    description: Swap event tracking for partner attribution
  - name: System
    description: Health check and API metadata
paths:
  /v1/onramp/status:
    get:
      tags:
        - On-Ramp
      summary: Check on-ramp order status
      description: >-
        Poll the status of a fiat-to-crypto order. Status progresses: waiting ->
        processing -> completed | failed | expired | canceled.
      operationId: getOnrampStatus
      parameters:
        - name: orderUid
          in: query
          required: true
          schema:
            type: string
          description: The order UID returned from checkout
      responses:
        '200':
          description: Order status
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/OnrampStatusResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        data:
          description: Response payload (null on error)
        error:
          nullable: true
          type: object
          properties:
            code:
              type: string
              example: INVALID_PARAMS
            message:
              type: string
              example: 'Missing required parameters: fromChain'
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - error
        - meta
    OnrampStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - waiting
            - processing
            - completed
            - failed
            - expired
            - canceled
        orderUid:
          type: string
        dstAmount:
          type: string
        txHash:
          type: string
    Meta:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: integer
          description: Unix epoch seconds
        rateLimit:
          type: object
          properties:
            limit:
              type: integer
            remaining:
              type: integer
            reset:
              type: integer
              description: Unix epoch seconds when the window resets
      required:
        - requestId
        - timestamp
  responses:
    BadRequest:
      description: Invalid or missing parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
    UpstreamError:
      description: Upstream provider error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Partner API key. Optional for public endpoints, required for
        /v1/partner/*.

````