> ## 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 Dashboard Summary

> Retrieves today's completed revenue volume, pending counts, active transaction logs (limit 5),
and the count of unread push notifications.




## OpenAPI

````yaml /api/mobile_api.yaml get /api/mobile/v1/dashboard
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/dashboard:
    get:
      summary: Retrieve Dashboard Summary
      description: >
        Retrieves today's completed revenue volume, pending counts, active
        transaction logs (limit 5),

        and the count of unread push notifications.
      operationId: getMobileDashboard
      parameters:
        - name: X-API-Version
          in: header
          required: false
          schema:
            type: string
          description: Gateway application version.
      responses:
        '200':
          description: Dashboard stats.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileDashboardResponse'
components:
  schemas:
    MobileDashboardResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            today:
              type: object
              properties:
                revenue:
                  type: string
                  example: '4500.00'
                total:
                  type: integer
                  example: 12
                pending:
                  type: integer
                  example: 2
            recent_transactions:
              type: array
              items:
                type: object
                properties:
                  trx_id:
                    type: string
                    example: OP-481029304
                  amount:
                    type: string
                    example: '500.00'
                  currency:
                    type: string
                    example: BDT
                  status:
                    type: string
                    example: completed
                  gateway:
                    type: string
                    nullable: true
                    example: bkash-merchant
                  created_at:
                    type: string
                    format: date-time
                    example: '2026-06-23T14:17:12Z'
            unread_notifications:
              type: integer
              example: 5
            server_time:
              type: string
              format: date-time
              example: '2026-06-23T14:15:45Z'
  securitySchemes:
    JWTAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your Short-lived access JWT token.

````

## Related topics

- [Retrieve Customer](/docs/api-reference/retrieve-customer.md)
- [Retrieve Refund](/docs/api-reference/retrieve-refund.md)
- [Retrieve Transaction](/docs/api-reference/retrieve-transaction.md)
- [Retrieve SMS Filter Rules](/docs/api-reference/retrieve-sms-filter-rules.md)
- [Retrieve Device Connection Status](/docs/api-reference/retrieve-device-connection-status.md)