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

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Retrieve Device Connection Status

> Retrieves the paired companion device's status details, its registered name, and platform identifiers from the database.




## OpenAPI

````yaml /api/mobile_api.yaml get /api/mobile/v1/devices/statuses
openapi: 3.1.0
info:
  title: OwnPay Mobile Companion App API
  description: >
    The OwnPay Mobile API is exposed exclusively to the paired mobile companion
    application.

    It contains endpoints to complete initial device pairing, submit heartbeats
    to report online statuses, refresh authentication tokens, upload received
    SMS messages (supporting batch processing up to 200 items), fetch pending
    outbound SMS queues, acknowledge push notifications, and retrieve dashboard
    statistics.


    ### Security and Cryptography

    - Except for `/api/mobile/v1/devices` (bootstrap pairing) and
    `/api/mobile/v1/devices/token-refreshes` (token refresh), all endpoints
    require authentication using a JSON Web Token (JWT) in the HTTP
    `Authorization` header.
      ```http
      Authorization: Bearer <jwt_access_token>
      ```
    - Device fingerprints are checked during token refreshes.

    - Endpoints are brand-scoped; data visibility is restricted to the specific
    brand/merchant.
  version: 1.0.0
servers:
  - url: https://{brand_domain}
    description: Master brand domain hosting OwnPay gateway.
    variables:
      brand_domain:
        default: ownpay.org
        description: The domain of the specific white-labeled gateway.
security:
  - JWTAuth: []
paths:
  /api/mobile/v1/devices/statuses:
    get:
      summary: Retrieve Device Connection Status
      description: >
        Retrieves the paired companion device's status details, its registered
        name, and platform identifiers from the database.
      operationId: getDeviceStatus
      responses:
        '200':
          description: Status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceStatusResponse'
        '404':
          description: Device not found in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
components:
  schemas:
    DeviceStatusResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            device_id:
              type: string
              description: Device UUID.
              example: b810d1c8-bc1e-4df1-b2f4-83b9c9d2b2f4
            device_name:
              type: string
              example: Samsung SM-G991B
            platform:
              type: string
              example: android
            status:
              type: string
              enum:
                - active
                - suspended
                - revoked
              example: active
            last_heartbeat:
              type: string
              format: date-time
              nullable: true
              example: '2026-06-23T14:15:00Z'
            merchant_id:
              type: integer
              example: 1
            server_time:
              type: string
              format: date-time
              example: '2026-06-23T14:15:45Z'
    ApiSingleErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid pairing code
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: INVALID_PAIRING_CODE
              message:
                type: string
                example: Invalid pairing code
              field:
                type: string
                nullable: true
                example: null
        request_id:
          type: string
          example: 8f5a2e9b0c7d4e5f
  securitySchemes:
    JWTAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your Short-lived access JWT token.

````

## Related topics

- [List Paired Companion Devices](/docs/api-reference/list-paired-companion-devices.md)
- [Retrieve Refund](/docs/api-reference/retrieve-refund.md)
- [Retrieve Transaction](/docs/api-reference/retrieve-transaction.md)
- [Paired Devices - Connect and Manage Android Phones](/docs/user-guide/mobile-sms/devices.md)
- [Retrieve Payment Details](/docs/api-reference/retrieve-payment-details.md)