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

# List payments

> Returns a paginated list of payments for the authenticated company.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/payments
openapi: 3.0.0
info:
  title: PlugToPay API
  description: API to make payments easy in multiple gateways.
  version: 1.0.0
servers:
  - url: http://localhost:7701
    description: Test Server
security: []
paths:
  /api/v1/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: Returns a paginated list of payments for the authenticated company.
      operationId: 9b4ce9f307bec3edaff45bd1ab6ea666
      parameters:
        - $ref: '#/components/parameters/XClientId'
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-01-01'
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-12-31'
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - approved
              - failed
              - refunded
        - name: gateway
          in: query
          required: false
          schema:
            type: string
            example: pagarme
        - name: payment_method
          in: query
          required: false
          schema:
            type: string
            enum:
              - pix
              - card
              - billet
        - name: amount_from
          in: query
          required: false
          schema:
            type: integer
            example: 1000
        - name: amount_to
          in: query
          required: false
          schema:
            type: integer
            example: 50000
        - name: transaction_id
          in: query
          required: false
          schema:
            type: string
            example: abc123
        - name: customer_email
          in: query
          required: false
          schema:
            type: string
            format: email
            example: customer@email.com
        - name: customer_document
          in: query
          required: false
          schema:
            type: string
            example: '12345678900'
        - name: card_brand
          in: query
          required: false
          schema:
            type: string
            example: visa
        - name: card_last_4
          in: query
          required: false
          schema:
            type: string
            example: '4242'
        - name: transaction_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - payment
              - withdraw
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            example: 15
        - name: page
          in: query
          required: false
          schema:
            type: integer
            example: 1
      responses:
        '200':
          description: Paginated list of payments
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      type: object
                  meta:
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 120
                      last_page:
                        type: integer
                        example: 8
                    type: object
                type: object
        '401':
          description: Unauthorized — Invalid API Key
        '422':
          description: Validation Error
      security:
        - ApiKeyAuth: []
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      description: Client identifier for the company in the request.
      required: true
      schema:
        type: string
        example: client_abc123
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Company API key. Send in the X-API-Key header.
      name: X-API-Key
      in: header

````