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

# List Companion App Notifications

> Retrieves the queue of push notifications dispatched for the authenticated device.




## OpenAPI

````yaml /api/mobile_api.yaml get /api/mobile/v1/notifications
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/notifications:
    get:
      summary: List Companion App Notifications
      description: >
        Retrieves the queue of push notifications dispatched for the
        authenticated device.
      operationId: listNotifications
      responses:
        '200':
          description: Notifications list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsListResponse'
components:
  schemas:
    NotificationsListResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 87
              type:
                type: string
                example: transaction_pending
              title:
                type: string
                example: Payment pending verification
              body:
                type: string
                example: Tk 500.00 pending on bKash
              data:
                type: string
                nullable: true
                description: JSON payload details as string.
                example: '{"trx_id":"OP-481029304","amount":"500.00"}'
              read_at:
                type: string
                format: date-time
                nullable: true
                example: null
              created_at:
                type: string
                format: date-time
                example: '2026-06-23T14:17:12Z'
  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)
- [List SMS Templates](/docs/api-reference/list-sms-templates.md)
- [Acknowledge Push Notifications](/docs/api-reference/acknowledge-push-notifications.md)
- [Pair Mobile Companion Device](/docs/api-reference/pair-mobile-companion-device.md)
- [List Customers](/docs/api-reference/list-customers.md)