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

# Acknowledge Push Notifications

> Marks a list of push notifications as read.
The request scopes operations by the device's UUID to block IDOR attacks, ensuring devices cannot silence other devices' notifications.




## OpenAPI

````yaml /api/mobile_api.yaml post /api/mobile/v1/notifications/acknowledgements
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/acknowledgements:
    post:
      summary: Acknowledge Push Notifications
      description: >
        Marks a list of push notifications as read.

        The request scopes operations by the device's UUID to block IDOR
        attacks, ensuring devices cannot silence other devices' notifications.
      operationId: acknowledgeNotifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcknowledgeNotificationsRequest'
      responses:
        '200':
          description: Acknowledgment recorded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      acknowledged:
                        type: integer
                        description: Count of notifications successfully marked as read.
                        example: 3
        '422':
          description: Missing notification IDs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
components:
  schemas:
    AcknowledgeNotificationsRequest:
      type: object
      required:
        - ids
      properties:
        ids:
          type: array
          items:
            type: integer
          example:
            - 87
            - 88
    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 Companion App Notifications](/docs/api-reference/list-companion-app-notifications.md)
- [Retrieve Dashboard Summary](/docs/api-reference/retrieve-dashboard-summary.md)
- [Features and Capabilities](/docs/resources/features.md)
- [OwnPay Skills for AI Agents - Platform Knowledge Pack](/docs/developer/ai-skills.md)
- [OwnPay API Overview - REST API for Multi-Brand Payments](/docs/api/overview.md)