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

# List Intents

> Retrieve a list of payment intents created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payment attempts for your account. It's useful for building dashboards, reconciling payments, or reviewing recent transactions programmatically.



## OpenAPI

````yaml GET /payments/intents
openapi: 3.0.1
info:
  title: xPay API Store
  description: ''
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.xpaycheckout.com
security:
  - basicAuth: []
paths:
  /payments/intents:
    get:
      description: >-
        Retrieve a list of payment intents created within a specific time range,
        with support for filtering and pagination. This endpoint allows you to
        track and analyse all payment attempts for your account. It's useful for
        building dashboards, reconciling payments, or reviewing recent
        transactions programmatically.
      parameters:
        - $ref: '#/components/parameters/StartTime'
        - $ref: '#/components/parameters/EndTime'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Successful response with payment intents and pagination cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-intents-response'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    StartTime:
      name: startTime
      in: query
      required: false
      schema:
        type: integer
        format: int64
      description: >-
        Start of range in epoch milliseconds. Fetches items created after this
        timestamp.
    EndTime:
      name: endTime
      in: query
      required: false
      schema:
        type: integer
        format: int64
      description: >-
        End of range in epoch milliseconds. Fetches items created before this
        timestamp.
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
      description: Max items per page (default 50, max 100)
      example: 100
    Offset:
      name: offset
      in: query
      required: false
      schema:
        type: string
      description: >-
        Cursor-based pagination token. Use the `offset` value from
        `metadata.offset` in the previous response to fetch the next page.
        Continue until `metadata.offset` is no longer present in the response.


        🚨 **Important**: Changing any query parameters invalidates existing
        offset values and requires restarting pagination from the beginning.


        For detailed pagination implementation guide, see [Pagination
        Guide](/developer-resources/pagination).
  schemas:
    get-intents-response:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntentSummary'
        metadata:
          type: object
          properties:
            offset:
              $ref: '#/components/schemas/PaginationOffset'
      required:
        - data
        - metadata
    Error:
      required:
        - errorCode
        - errorDescription
      type: object
      properties:
        errorCode:
          type: string
          example: bad_request
        errorDescription:
          type: string
          example: Failed to read request
    IntentSummary:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
          example: 2000
        currency:
          type: string
          description: Three-letter currency code
          example: USD
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        status:
          type: string
          description: >-
            Current status of the intent. Refer [payment
            statuses](/products/one-time-payments/payment-statuses)
          example: SUCCESS
        succeededAt:
          $ref: '#/components/schemas/SucceededAt'
        receiptId:
          type: string
          description: Your identifier for the order
          example: '1234567890'
        xIntentId:
          type: string
          description: Unique identifier of the intent
          example: in_fnXr3r2P1bEiiE1n
      required:
        - amount
        - currency
        - createdAt
        - status
        - xIntentId
    PaginationOffset:
      type: string
      description: >-
        Pagination cursor for fetching the next page of results. Use this exact
        string as the `offset` parameter in your next API request. When this
        field is missing or null, you've reached the end of the results.


        For detailed pagination implementation guide, see [Pagination
        Guide](/developer-resources/pagination).
    Amount:
      type: integer
      format: int64
      description: >-
        The amount in lowest count unit. e.g.: For USD 1, amount is 100
        representing 100 cents (The minimum amount should be greater than 1 USD)
      example: 2000
    CreatedAt:
      type: integer
      description: Epoch timestamp in milliseconds of when the intent was created
      example: 1727340330123
    SucceededAt:
      type: integer
      description: >-
        Epoch timestamp in milliseconds of when the payment was successfully
        completed
      example: 1727340330123
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````