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

# Get aggregate API availability

> Returns the current aggregate availability of the Flowlix API. This
operation is public and always returns HTTP 200 when the gateway can
answer. Inspect `status` instead of the HTTP status code.

`operational` means the required downstream connectivity evidence is
fresh and successful. `outage` means that evidence is missing, stale,
or failed. `degraded` is reserved for future partial-capability
reporting. Capability-specific fields may be added under `details`
without changing this top-level contract. This aggregate status is not
a per-operation SLA or a guarantee that any individual transaction will
succeed.




## OpenAPI

````yaml /api-reference/payments-api.yaml get /v1/health
openapi: 3.0.4
info:
  title: Flowlix Payments API
  version: 1.0.0
  description: >
    The Flowlix Payments API is a RESTful API for accepting and managing online
    payments.

    It follows industry-standard conventions: JSON request/response bodies,
    Bearer token authentication,

    standard HTTP verbs, idempotency support, and cursor-based pagination.


    ## Base URL


    All API requests are made to `https://api.flowlix.dev`. Current endpoints

    are versioned under `/v1`, e.g. `https://api.flowlix.dev/v1/payments`.


    ## Amounts and currencies


    All monetary amounts are expressed in **minor units** (the smallest currency
    unit).

    How many minor units make up one major unit is defined by the currency's

    ISO 4217 exponent, so the same integer means a different value in different

    currencies: `4999` is **EUR 49.99** and **GBP 49.99** (exponent 2), but

    **JPY 4999** (exponent 0, no minor unit). Do not assume two decimal places.


    Currencies are three-letter ISO 4217 codes. Requests are accepted

    case-insensitively; Flowlix normalizes them and always returns canonical

    uppercase codes such as `EUR`, `GBP`, or `JPY`. The set of currencies

    available for card acquiring is validated per request rather than listed in

    this contract, so enabling another currency is not a breaking change. A code

    that is not three letters is rejected with `400 parameter_invalid`

    (`param=currency`), and a well-formed code that Flowlix does not accept for

    new payments is rejected with `422 currency_not_supported`. Neither creates
    a

    payment.


    A refund is always made in the currency of the original payment, and the

    refund request does not accept a currency.
  contact:
    name: Flowlix Developer Support
    email: developers@flowlix.eu
    url: https://flowlix.dev/support
  license:
    name: Proprietary
    url: https://flowlix.dev/terms
servers:
  - url: https://api.flowlix.dev
    description: |
      Flowlix API. Test mode and live mode share the same host; the mode is
      selected by the API key prefix (`api_test_sk_*` or `api_live_sk_*`).
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Check aggregate Flowlix API availability.
  - name: Payments
    description: Create, retrieve, and list payments.
  - name: Refunds
    description: >-
      Create refunds and track their status through the parent payment's
      `refunds` array.
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Get aggregate API availability
      description: |
        Returns the current aggregate availability of the Flowlix API. This
        operation is public and always returns HTTP 200 when the gateway can
        answer. Inspect `status` instead of the HTTP status code.

        `operational` means the required downstream connectivity evidence is
        fresh and successful. `outage` means that evidence is missing, stale,
        or failed. `degraded` is reserved for future partial-capability
        reporting. Capability-specific fields may be added under `details`
        without changing this top-level contract. This aggregate status is not
        a per-operation SLA or a guarantee that any individual transaction will
        succeed.
      operationId: getGatewayHealth
      responses:
        '200':
          description: Aggregate gateway availability at the reported check time.
          headers:
            Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayHealth'
      security: []
components:
  headers:
    RequestId:
      description: >-
        A unique identifier for this API request. Include it when contacting
        support.
      schema:
        type: string
        maxLength: 255
      example: req_abc123def456
  schemas:
    GatewayHealth:
      type: object
      additionalProperties: false
      required:
        - status
        - checked_at
        - details
      properties:
        status:
          type: string
          enum:
            - operational
            - degraded
            - outage
          description: Aggregate API availability.
          example: operational
        checked_at:
          type: string
          format: date-time
          description: UTC timestamp when the gateway evaluated this response.
          example: '2026-08-05T12:34:56Z'
        details:
          type: object
          additionalProperties: true
          description: Reserved for additive capability details; empty in this version.
          example: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Use your secret API key as the Bearer token. Test mode keys start with
        `api_test_sk_` and live mode keys start with `api_live_sk_`. Both modes
        use the same API host; the mode is determined by the key.

        ```
        Authorization: Bearer api_test_sk_abc123def456
        ```

````