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

# Update a terminal

> Renames the terminal, moves it to another of your locations, or both. The name shows in the API, in RevOS and in the Virtual Terminal. A field left out stays as it is; `null` removes it. A `location` that is not one of yours answers `400 parameter_invalid`.



## OpenAPI

````yaml /api-reference/openapi-v1.json post /terminals/{id}
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}:
    post:
      tags:
        - Terminals
      summary: Update a terminal
      description: >-
        Renames the terminal, moves it to another of your locations, or both.
        The name shows in the API, in RevOS and in the Virtual Terminal. A field
        left out stays as it is; `null` removes it. A `location` that is not one
        of yours answers `400 parameter_invalid`.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 64
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 120
                  example: Truck 412
                  description: >-
                    The new name, 1 to 120 characters; `null` removes it. Left
                    out, the name stays.
                location:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 64
                  example: 019f2c4e-6a10-7b2c-8d31-2a4b6c8d0e12
                  description: >-
                    The `id` of one of your locations to move the terminal to;
                    `null` takes it off any. Left out, the location stays.
              additionalProperties: false
      responses:
        '200':
          description: The terminal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Terminal'
        '400':
          description: Invalid parameters
          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:
    Terminal:
      type: object
      properties:
        object:
          type: string
          enum:
            - terminal
        id:
          type: string
          format: uuid
          example: 019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61
          description: Pass it as `terminal` on a payment.
        label:
          type:
            - string
            - 'null'
          example: Truck 412
          description: >-
            Your name for the terminal, such as the truck it rides in; null
            until you name it.
        model:
          type:
            - string
            - 'null'
          example: AMS1
        serial_number:
          type:
            - string
            - 'null'
          example: '1853000123'
          description: Printed on the back of the terminal.
        checked_out_to:
          type:
            - string
            - 'null'
          example: Tablet TB0011
          description: >-
            Who has the terminal right now, as you named them at check-out: a
            tablet, a truck, a driver. `null` while it sits free.
        checked_out_at:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-10-21T12:05:00.000Z'
          description: When it was checked out; `null` while it sits free.
        checked_out_by:
          type:
            - string
            - 'null'
          example: j.doe
          description: >-
            Your user who did the check-out, as you sent it; `null` when you
            sent none or while the terminal sits free.
        location:
          $ref: '#/components/schemas/TerminalLocation'
        livemode:
          type: boolean
          example: false
      required:
        - object
        - id
        - label
        - model
        - serial_number
        - checked_out_to
        - checked_out_at
        - checked_out_by
        - location
        - livemode
    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
    TerminalLocation:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
          format: uuid
          example: 019f2c4e-6a10-7b2c-8d31-2a4b6c8d0e12
          description: Pass it as `location` to filter or move.
        name:
          type: string
          example: Cheyenne plant
      required:
        - id
        - name
      description: >-
        The store or plant the terminal works from, one of your locations (`GET
        /v1/locations`); `null` until one is set.
  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.