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

# Health check



## OpenAPI

````yaml /openapi.yaml get /health
openapi: 3.1.0
info:
  title: Meum Public Merchant API
  version: 1.0.0
  description: >
    Public merchant API for programmatic payment management: invoices,
    transactions,

    payment links, webhooks, and WooCommerce integration.


    Authenticate with a store-scoped API key (`sk_live_*`) via Bearer token.

    Base URL: https://api.meum.io
  contact:
    name: Meum Support
    email: support@meum.io
    url: https://meum.io
servers:
  - url: https://api.meum.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Service health checks
  - name: Invoices
    description: Invoice lifecycle
  - name: Transactions
    description: On-chain payment transactions
  - name: Payment Links
    description: Reusable payment link management
  - name: Webhooks
    description: Webhook endpoint and delivery management
  - name: Integrations
    description: Third-party platform integrations
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      operationId: getHealth
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: ok
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          description: >-
            Overall API health. Expect `ok` when the service is accepting
            traffic.
          example: ok
        service:
          type: string
          description: Optional process label. Do not depend on this value in integrations.
          example: meum-api
        near_mode:
          type: string
          enum:
            - mock
            - real
          description: Blockchain integration mode (`real` in production).
        worker_heartbeat:
          type:
            - object
            - 'null'
          description: Background worker liveness signal, when available.
          properties:
            status:
              type: string
              description: Worker health status.
            last_at:
              type: string
              format: date-time
              description: Time of the last worker heartbeat (UTC).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Store-scoped API key. Prefix with `sk_live_`.
        Example: `Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE`

````