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

# List Payments

> Retrieve a paginated list of all payment transactions for your account.

Retrieve a paginated list of all payment transactions for your account. This endpoint allows you to view your payment history with filtering and pagination.

## Overview

This endpoint returns a paginated list of all payment transactions associated with your account, sorted by creation date (newest first).

## Query Parameters

<ParamField query="page" type="integer">
  Page number for pagination (default: 1)
</ParamField>

<ParamField query="per_page" type="integer">
  Number of items per page (default: 20)
</ParamField>

## Response

<ResponseField name="data" type="object">
  Paginated response containing:

  * `total_pages`: Total number of pages
  * `current_page`: Current page number
  * `total_records`: Total number of payment records
  * `next_page`: URL for next page (empty if last page)
  * `previous_page`: URL for previous page (empty if first page)
  * `items`: Array of payment objects
</ResponseField>

<ResponseField name="data.items[]" type="object">
  Each payment object includes:

  * `id`: Payment transaction ID
  * `reference`: Payment reference
  * `amount`: Payment amount
  * `currency`: Currency code
  * `status`: Payment status
  * `type`: Transaction type (debit/credit)
  * `category`: Transaction category
  * `channel`: Payment channel
  * `is_completed`: Completion status
  * `transaction_date`: Transaction timestamp
</ResponseField>


## OpenAPI

````yaml GET /payments
openapi: 3.0.0
info:
  title: Pooler Developer API
  description: >-
    Comprehensive API documentation for Pooler payment and financial services
    platform
  version: 1.0.0
servers:
  - url: https://api.usepooler.com
    description: Production server
  - url: https://sandbox.usepooler.com
    description: Sandbox server
security:
  - bearerAuth: []
paths:
  /payments:
    get:
      tags:
        - Payments
      summary: List Payments
      description: Retrieve a paginated list of all payment transactions for your account.
      operationId: listPayments
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          description: Number of items per page
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Payments retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPaymentsResponse'
components:
  schemas:
    PaginatedPaymentsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        stan:
          type: string
          format: uuid
        data:
          $ref: '#/components/schemas/PaginatedPayments'
    PaginatedPayments:
      type: object
      properties:
        total_pages:
          type: integer
        current_page:
          type: integer
        total_records:
          type: integer
        next_page:
          type: string
        previous_page:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
    Payment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        reference:
          type: string
        status:
          type: string
          enum:
            - pending
            - completed
            - failed
        amount:
          type: string
        currency:
          type: string
        description:
          type: string
        type:
          type: string
        sub_type:
          type: string
        category:
          type: string
        transaction_date:
          type: string
          format: date-time
        tags:
          type: string
        is_reversed:
          type: boolean
        is_completed:
          type: boolean
        channel:
          type: string
        notes:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Include your API key in the Authorization
        header as: Bearer {your_api_key}

````