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

# Health check

> Returns 200 when the API is serving. No authentication. Useful as an uptime probe; it does not check downstream providers, so a 200 here does not guarantee a quote will succeed.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/ping
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:
  /v1/ping:
    get:
      tags:
        - catalog
      summary: Health check
      description: >-
        Returns 200 when the API is serving. No authentication. Useful as an
        uptime probe; it does not check downstream providers, so a 200 here does
        not guarantee a quote will succeed.
      operationId: PingController_ping
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponseDto'
components:
  schemas:
    PingResponseDto:
      type: object
      properties:
        status:
          type: string
          example: ok
          description: Liveness marker.
        service:
          type: string
          example: backend
          description: Service name.
        version:
          type: string
          example: v0.2.37
          description: Running version (APP_VERSION).
        time:
          type: string
          example: '2026-07-08T12:00:00.000Z'
          description: Server time (ISO 8601).
      required:
        - status
        - service
        - version
        - time

````