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

# List payments



## OpenAPI

````yaml GET /payments
openapi: 3.1.0
info:
  title: Wave Lines API
  version: 1.0.0
servers: []
security:
  - client_id: []
    secret_key: []
tags:
  - name: lines
    description: Line lifecycle operations
  - name: payments
    description: Payment listing and lookup
  - name: tax-receipts
    description: Tax receipt listing, lookup and document download
  - name: subscriptions
    description: Subscription lookup, product management and invoices
  - name: holders
    description: Holder (customer) listing, lookup and creation
  - name: usage
    description: 'Usage: per-product line balance and consumption'
  - name: Portability
    description: >-
      Number portability: port-in request creation, listing, modification and
      cancellation, plus the consolidated portability status
  - name: Inventory
    description: >-
      Inventory resource pools: pool listing, the resources held in a pool and
      resource reservations
  - name: Catalog
    description: Catalog offers exposed by the Wave Catalog API
paths:
  /payments:
    get:
      tags:
        - payments
      parameters:
        - schema:
            type: string
            format: uuid
          in: query
          name: lineId
          required: false
        - schema:
            type: number
            exclusiveMinimum: 0
            default: 1
          in: query
          name: page
          required: false
        - schema:
            type: number
            exclusiveMinimum: 0
            maximum: 100
            default: 10
          in: query
          name: pageSize
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        accountId:
                          type:
                            - 'null'
                            - string
                        brokerId:
                          type: string
                        customerId:
                          type: string
                        paymentMethodId:
                          type:
                            - 'null'
                            - string
                        amount:
                          type: number
                        status:
                          type: string
                          enum:
                            - PENDING
                            - FAILED
                            - CANCELED
                            - SUCCESS
                        description:
                          type: string
                        shortDescription:
                          type: string
                        currency:
                          type: string
                          enum:
                            - BRL
                            - MXN
                        externalCode:
                          type:
                            - 'null'
                            - string
                        metadata:
                          anyOf:
                            - type: object
                              additionalProperties:
                                type:
                                  - string
                                  - number
                                  - 'null'
                            - type: 'null'
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        operations:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              providerId:
                                type: string
                              transactionId:
                                type: string
                              paymentMethodId:
                                type: string
                              amount:
                                type: number
                              status:
                                type: string
                                enum:
                                  - PENDING
                                  - SUCCESS
                                  - FAILED
                              responseDescription:
                                type: string
                              type:
                                type: string
                                enum:
                                  - AUTHORIZATION
                                  - CAPTURE
                                  - REFUND
                                  - CHARGEBACK
                              providerTransactionId:
                                type: string
                              retries:
                                type: number
                              metadata:
                                anyOf:
                                  - type: object
                                    additionalProperties:
                                      type:
                                        - string
                                        - number
                                        - 'null'
                                  - type: 'null'
                              createdAt:
                                type: string
                              updatedAt:
                                type: string
                            required:
                              - id
                              - providerId
                              - transactionId
                              - paymentMethodId
                              - amount
                              - status
                              - responseDescription
                              - type
                              - providerTransactionId
                              - retries
                              - metadata
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                      required:
                        - id
                        - accountId
                        - brokerId
                        - customerId
                        - paymentMethodId
                        - amount
                        - status
                        - description
                        - shortDescription
                        - currency
                        - externalCode
                        - metadata
                        - createdAt
                        - updatedAt
                        - operations
                      additionalProperties: false
                  page:
                    type: integer
                  pageSize:
                    type: integer
                  total:
                    type: integer
                    minimum: 0
                required:
                  - items
                  - page
                  - pageSize
                  - total
                additionalProperties: false
components:
  securitySchemes:
    client_id:
      type: apiKey
      in: header
      name: client_id
    secret_key:
      type: apiKey
      in: header
      name: secret_key

````