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

# List a terminal's check-outs

> The terminal's check-outs on your account, newest first, with who took it, who sent the request and how each one ended. The first one is the current check-out while its `checked_in_at` is null. Readable while the terminal is assigned to your account; otherwise `404`.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /terminals/{id}/check-outs
openapi: 3.1.0
info:
  title: Payra API
  version: v1
  description: >-
    The Payra API. Authenticate with a secret key: `Authorization: Bearer
    sk_test_...`. The two payment method session endpoints Payra Elements calls
    also take a publishable key with the session's `client_secret`.
servers:
  - url: https://api-dashboard.payra.com/v1
    description: 'Sandbox and live: the key decides which'
security: []
paths:
  /terminals/{id}/check-outs:
    get:
      tags:
        - Terminals
      summary: List a terminal's check-outs
      description: >-
        The terminal's check-outs on your account, newest first, with who took
        it, who sent the request and how each one ended. The first one is the
        current check-out while its `checked_in_at` is null. Readable while the
        terminal is assigned to your account; otherwise `404`.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 64
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            example: 20
            description: How many to return, 1 to 100.
          required: false
          description: How many to return, 1 to 100.
          name: limit
          in: query
        - schema:
            type: string
            format: uuid
            description: >-
              The `id` of the last check-out of the previous page; the page
              after it is returned.
          required: false
          description: >-
            The `id` of the last check-out of the previous page; the page after
            it is returned.
          name: starting_after
          in: query
      responses:
        '200':
          description: A page of check-outs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalCheckOutList'
        '400':
          description: '`limit` out of range, or `starting_after` is malformed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API is not enabled for the workspace, or the key lacks the scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such terminal in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    TerminalCheckOutList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/TerminalCheckOut'
        has_more:
          type: boolean
      required:
        - object
        - data
        - has_more
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - idempotency_error
                - card_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - request_id
          additionalProperties:
            type: string
      required:
        - error
    TerminalCheckOut:
      type: object
      properties:
        object:
          type: string
          enum:
            - terminal_check_out
        id:
          type: string
          format: uuid
        terminal:
          type: string
          format: uuid
          example: 019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61
        checked_out_to:
          type: string
          example: Tablet TB0011
        checked_out_by:
          type:
            - string
            - 'null'
          example: j.doe
        checked_out_at:
          type: string
          format: date-time
          example: '2026-10-21T12:05:00.000Z'
        checked_in_at:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-10-21T22:40:00.000Z'
          description: '`null` while this check-out is still the current one.'
        checked_in_by:
          type:
            - string
            - 'null'
          example: j.doe
          description: >-
            Who checked it in: the `checked_in_by` your check-in sent, `Payra`
            for a `nightly_release`, or the name of the RevOS user for a
            `dashboard_check_in`. `null` while open or when none was sent.
        end_reason:
          type:
            - string
            - 'null'
          enum:
            - check_in
            - replaced
            - unassigned
            - transferred
            - nightly_release
            - dashboard_check_in
          example: check_in
          description: >-
            How it ended: `check_in`, `replaced` (another check-out took the
            terminal over), `nightly_release` when Payra released a check-out
            left from before 2 AM in your account's time zone (by the hourly
            release, or by a later check-out that found it first),
            `dashboard_check_in` when one of your users checked it in from
            RevOS, `unassigned` when Payra took the terminal off your account,
            `transferred` when Payra moved it to another account. `null` while
            open. More values may be added.
        livemode:
          type: boolean
          example: false
      required:
        - object
        - id
        - terminal
        - checked_out_to
        - checked_out_by
        - checked_out_at
        - checked_in_at
        - checked_in_by
        - end_reason
        - livemode
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A secret key, `sk_test_...` or `sk_live_...`; a publishable key
        (`pk_...`) on the browser routes only

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.