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

# List Terminal provisioning options

> Returns the Terminal integrations and device models currently available
for new provisioning requests. This catalog is scoped only by the
authenticated Account and key mode; `Ionic-Account` is not accepted.




## OpenAPI

````yaml /openapi/terminal-management.yaml get /terminal_provisioning_catalog
openapi: 3.0.3
info:
  title: Ionic Terminal Management API
  version: '2026-09-02'
  description: |
    Request physical Terminal hardware, inspect Merchant-owned Terminals, and
    read Ionic's terminal batch and settlement records.

    Every resource is scoped to the authenticated Merchant and the secret
    key's test or live mode. Request bodies never select `merchant_id` or
    `livemode`. Platforms use `Ionic-Account` for the same inventory,
    provisioning, connection-observation, and batch operations on an
    authorized connected Account.

    Every test Account automatically has two Ionic test Locations and three
    ready simulated Terminals. Their IDs are unique to the Account, while the
    `test_profile` catalog is universal: `approved`, `declined`, and `delayed`.
    Physical hardware is created only through
    `POST /terminal_provisioning_requests`.
servers:
  - url: '{baseUrl}/v1'
    variables:
      baseUrl:
        default: https://api.ionicfi.com
        description: API base URL for the selected environment.
security:
  - secretKey: []
tags:
  - name: Terminal Provisioning
    description: Request physical hardware and track fulfillment.
  - name: Terminals
    description: Inspect Merchant-owned Terminal inventory and readiness.
  - name: Terminal Batches
    description: Read Ionic batch, item, and settlement records.
paths:
  /terminal_provisioning_catalog:
    get:
      tags:
        - Terminal Provisioning
      summary: List Terminal provisioning options
      description: |
        Returns the Terminal integrations and device models currently available
        for new provisioning requests. This catalog is scoped only by the
        authenticated Account and key mode; `Ionic-Account` is not accepted.
      operationId: terminal_provisioning_catalog_retrieve
      responses:
        '200':
          description: The current provisioning catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalProvisioningCatalog'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ReadForbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - secretKey:
            - terminals:read
components:
  schemas:
    TerminalProvisioningCatalog:
      type: object
      additionalProperties: false
      required:
        - object
        - integrations
      properties:
        object:
          type: string
          enum:
            - terminal.provisioning_catalog
        integrations:
          type: array
          items:
            $ref: '#/components/schemas/TerminalProvisioningCatalogIntegration'
    TerminalProvisioningCatalogIntegration:
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - device_models
      properties:
        id:
          type: string
          description: Stable integration identifier used by Ionic.
        name:
          type: string
          description: Display name for the integration.
        device_models:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ReadForbidden:
      description: Invalid delegation or missing `terminals:read` permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Too many requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      bearerFormat: Ionic secret key
      description: >-
        Merchant secret key, or an authorized Platform secret key with
        delegation where documented.

````