> ## 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. # Check a terminal out > Hands the terminal to a tablet, truck or person until it is checked back in. A terminal checked out to someone else since the last nightly release (2 AM in your account's time zone) answers `400 terminal_checked_out` with `checked_out_to` naming who has it, unless `replace` is true; without `replace`, one still out from before that release is released first (`end_reason` `nightly_release`) and checked out to you. A check-out to whoever already has it since that release answers 200 as it is; list with `checked_out=false` to pick a free one. Payments are not affected: a checked-out terminal takes them as before. ## OpenAPI ````yaml /api-reference/openapi-v1.json post /terminals/{id}/check-out 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-out: post: tags: - Terminals summary: Check a terminal out description: >- Hands the terminal to a tablet, truck or person until it is checked back in. A terminal checked out to someone else since the last nightly release (2 AM in your account's time zone) answers `400 terminal_checked_out` with `checked_out_to` naming who has it, unless `replace` is true; without `replace`, one still out from before that release is released first (`end_reason` `nightly_release`) and checked out to you. A check-out to whoever already has it since that release answers 200 as it is; list with `checked_out=false` to pick a free one. Payments are not affected: a checked-out terminal takes them as before. parameters: - schema: type: string minLength: 1 maxLength: 64 required: true name: id in: path requestBody: required: true content: application/json: schema: type: object properties: checked_out_to: type: string minLength: 1 maxLength: 120 example: Tablet TB0011 description: >- Who takes the terminal, 1 to 120 characters. Shown in RevOS next to the terminal. checked_out_by: type: string minLength: 1 maxLength: 120 example: j.doe description: >- Your user doing the check-out, kept in the terminal's check-out history for your audit. replace: type: boolean example: false description: >- Take the terminal over from whoever has it instead of answering `terminal_checked_out`. Send it only when you know the terminal is in hand, such as a check-in someone forgot since the last nightly release; one from before that release is released without it. required: - checked_out_to additionalProperties: false responses: '200': description: The terminal, checked out content: application/json: schema: $ref: '#/components/schemas/Terminal' '400': description: >- Invalid parameters, or `terminal_checked_out` when someone else has had it since the last nightly release 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' '409': description: The terminal changed hands while the request ran; retry 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. livemode: type: boolean example: false required: - object - id - label - model - serial_number - checked_out_to - checked_out_at - checked_out_by - 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 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.