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

# Payments Summary

> Returns the buyer’s total number of Router payment requests (uncapped — unlike the 1000-row
list endpoint) plus a per-bucket time-series for a dashboard chart. Filter by `from`/`to`
(ISO-8601, inclusive on `createdAt`); choose the bucket size with `granularity` (day/week/month).



## OpenAPI

````yaml GET /router/payments/summary
openapi: 3.1.0
info:
  title: Nevermined API
  description: >-
    API for managing AI agents, payment plans, and x402 payments in the
    Nevermined ecosystem.


    ## Prerequisites


    You need a Nevermined API Key to authenticate. Get one at
    [nevermined.app](https://nevermined.app) under **Settings > API Keys**.


    See the [5-Minute Setup Guide](/docs/integrate/quickstart/5-minute-setup)
    for detailed instructions.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.sandbox.nevermined.app/api/v1
    description: Sandbox (Testing) - Base Sepolia
  - url: https://api.live.nevermined.app/api/v1
    description: Live (Production) - Base Mainnet
security:
  - bearerAuth: []
tags:
  - name: Protocol - Agents
    description: Endpoints for registering and managing AI agents
  - name: Protocol - Plans
    description: Endpoints for creating and managing payment plans
  - name: Protocol - Credits
    description: Endpoints for minting and redeeming credits
  - name: Protocol - Access
    description: Endpoints for access tokens and request validation
  - name: X402 - Permissions
    description: Endpoints for x402 delegated permissions
paths:
  /router/payments/summary:
    get:
      tags:
        - Router
      summary: Aggregate count + time-series of the buyer’s payment requests
      description: >-
        Returns the buyer’s total number of Router payment requests (uncapped —
        unlike the 1000-row

        list endpoint) plus a per-bucket time-series for a dashboard chart.
        Filter by `from`/`to`

        (ISO-8601, inclusive on `createdAt`); choose the bucket size with
        `granularity` (day/week/month).
      operationId: routerPaymentsSummary
      parameters:
        - name: from
          required: false
          in: query
          description: ISO-8601 lower bound on createdAt (inclusive).
          schema:
            example: '2026-07-01T00:00:00Z'
            type: string
        - name: to
          required: false
          in: query
          description: ISO-8601 upper bound on createdAt (inclusive).
          schema:
            example: '2026-07-31T23:59:59Z'
            type: string
        - name: granularity
          required: false
          in: query
          description: Bucket size. Defaults to day.
          schema:
            enum:
              - day
              - week
              - month
            type: string
      responses:
        '200':
          description: Total + time-series.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsSummaryDto'
        '400':
          description: '`from`/`to` are not valid ISO-8601 timestamps (BCK.ROUTER.0001).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouterErrorResponseDto'
        '401':
          description: Missing/invalid Nevermined API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouterErrorResponseDto'
components:
  schemas:
    PaymentsSummaryDto:
      type: object
      properties:
        total:
          type: number
          description: >-
            Total payment requests in the period. Uncapped, unlike the
            (1000-row-capped) list endpoint.
          example: 137
        series:
          description: Per-bucket counts, oldest first.
          type: array
          items:
            $ref: '#/components/schemas/PaymentsSummaryPointDto'
      required:
        - total
        - series
    RouterErrorResponseDto:
      type: object
      properties:
        code:
          type: string
          description: >-
            Router error code. `BCK.ROUTER.0001` invalid request / no fundable
            option / bad 402 (400); `BCK.ROUTER.0002` requestId already used —
            idempotency conflict (409); `BCK.ROUTER.0003` delegation budget
            exceeded, expired, or inactive (402); `BCK.ROUTER.0004` payment
            record not found (404); `BCK.ROUTER.0005` payment not in a
            settleable state (409). Framework-level `BCK.HTTP.*` codes (e.g.
            `BCK.HTTP.400` request validation, `BCK.HTTP.429` throttling) may
            also appear — see the base `code` field.
          example: BCK.ROUTER.0003
        httpStatus:
          type: number
          description: HTTP status code
          example: 500
        message:
          type: string
          description: Error message for Router operations.
          example: delegation budget exceeded, expired, or inactive
          examples:
            - >-
              delegationId is required — create one via POST
              /api/v1/delegation/create
            - 'no fundable option; offered: [...]'
            - >-
              upstream pay-to address is not in this delegation's allowed
              recipients
            - delegation budget exceeded, expired, or inactive
            - payment already settled with a different txHash
        details:
          type: string
          description: >-
            Throw-site detail string supplementing the canonical message. Only
            set when the call site supplied an opts.message; absent otherwise.
          example: Hash JWT is not signed by the node account
        error:
          type: string
          description: >-
            RFC 6749 §5.2 / RFC 8628 §3.5 top-level OAuth error string. Present
            only on the OAuth device-polling responses from `POST /oauth/token`
            (`authorization_pending`, `slow_down`, `expired_token`,
            `access_denied`), so a standards-compliant OAuth/device client can
            branch on it directly instead of on the Nevermined `code`. Absent on
            every other error.
          example: authorization_pending
        hint:
          type: string
          description: >-
            Actionable remediation hint, sourced from the catalogue or supplied
            at the throw site. Tells the caller what to fix or where to look.
          example: >-
            Verify the wallet has sufficient balance and that the plan is
            active.
        docsUrl:
          type: string
          description: Permalink to the docs page describing this error code.
          example: >-
            https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008
        category:
          type: string
          description: >-
            Coarse classification of the failure, useful for client-side
            branching without parsing the message.
          enum:
            - validation
            - auth
            - business
            - integration
            - internal
          example: integration
        retryable:
          type: boolean
          description: >-
            Whether the failure is transient and the same call can be retried
            with identical inputs. Absent when the catalogue does not assert
            either way.
          example: true
        correlationId:
          type: string
          description: >-
            Request-scoped correlation id stamped by the global filter. Echoed
            in the x-correlation-id response header. Quote this when reporting
            issues.
          example: a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9
        uuid:
          type: string
          description: >-
            Per-error UUID generated at construction. Useful for log
            correlation.
          example: e-550e8400-e29b-41d4-a716-446655440000
        date:
          type: string
          description: ISO timestamp at which the error was constructed.
          example: '2026-05-09T12:34:56.789Z'
          format: date-time
        params:
          type: string
          description: >-
            JSON-stringified contextual parameters supplied at the throw site
            (e.g. IDs, state). Always a string in the wire format — parse with
            JSON.parse if needed.
          example: '{"planId":"43298432984329","reason":"Invalid configuration"}'
      required:
        - code
        - httpStatus
        - message
    PaymentsSummaryPointDto:
      type: object
      properties:
        date:
          type: string
          description: >-
            Start of the time bucket (ISO-8601, UTC), truncated to the requested
            granularity.
          example: '2026-07-01T00:00:00.000Z'
        value:
          type: number
          description: Number of payment requests issued in the bucket.
          example: 12
      required:
        - date
        - value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Nevermined API Key (starts with 'nvm:'). Get one at
        [nevermined.app](https://nevermined.app) under **Settings > API Keys**.

````

## Related topics

- [Payment ledger](/docs/products/router/ledger.md)
- [X402 Protocol](/docs/api-reference/typescript/x402.md)
- [Nevermined x402](/docs/development-guide/nevermined-x402.md)
- [Observability & Monitoring](/docs/development-guide/observability.md)
- [x402 Smart Accounts Extension](/docs/specs/x402-smart-accounts.md)
