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

# Retorna lista de pagamentos agrupados por pedido

<Note>
  **🚀 API v2 (Recomendada)** - Use este endpoint para novos projetos
</Note>


## OpenAPI

````yaml /openapi/openapi-v2.json GET /payments/{pageNumber}/{pageLimit}
openapi: 3.0.0
info:
  title: Documentação de API
  version: '2.0'
servers:
  - url: https://backend-pied-prod.piedadmin.com.br/api/v2
security:
  - bearerAuth: []
tags:
  - name: Request
    description: Tudo sobre orçamentos ou pedidos
  - name: Equipment
    description: Tudo sobre equipamentos
  - name: Company
    description: Tudo sobre empresas de energia
  - name: Custom Field
    description: Tudo sobre campos customizados
  - name: Payments
    description: Tudo sobre pagamentos
paths:
  /payments/{pageNumber}/{pageLimit}:
    get:
      tags:
        - Payments
      summary: Retorna lista de pagamentos agrupados por pedido
      parameters:
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - name: orderId
          in: query
          schema:
            type: string
          description: ID do pedido
        - name: orderCode
          in: query
          schema:
            type: string
          description: Código do pedido
        - name: status
          in: query
          schema:
            type: string
          description: Status geral do pagamento
        - $ref: '#/components/parameters/createdBefore'
        - $ref: '#/components/parameters/createdAfter'
        - $ref: '#/components/parameters/updatedBefore'
        - $ref: '#/components/parameters/updatedAfter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        orderId:
                          type: string
                          description: ID do pedido
                        status:
                          type: string
                          enum:
                            - notRequested
                            - requested
                            - received
                            - cancelled
                            - partial
                          description: Status geral do pagamento
                        payments:
                          $ref: '#/components/schemas/payment_v2'
                  meta:
                    type: object
                    properties:
                      totalItems:
                        type: integer
                      itemsPerPage:
                        type: integer
                      totalPages:
                        type: integer
                      currentPage:
                        type: integer
                      links:
                        type: object
                        properties:
                          first:
                            type: string
                          last:
                            type: string
                          next:
                            type: string
                          previous:
                            type: string
        '429':
          $ref: '#/components/schemas/429'
        '500':
          $ref: '#/components/schemas/500'
      security:
        - bearerAuth: []
components:
  parameters:
    pageNumber:
      name: pageNumber
      in: path
      description: Determina o número da página a ser retornada.
      required: true
      schema:
        type: integer
    pageLimit:
      name: pageLimit
      in: path
      description: Limita a quantidade de registros retornados por página.
      required: true
      schema:
        type: integer
    createdBefore:
      name: createdBefore
      in: query
      description: >-
        A pesquisa retorna registros criados até esta data passada no parâmetro.
        Formato (AAAA-MM-DD).
      schema:
        type: string
    createdAfter:
      name: createdAfter
      in: query
      description: >-
        A pesquisa retorna registros criados a partir desta data passada no
        parâmetro. Formato (AAAA-MM-DD).
      schema:
        type: string
    updatedBefore:
      name: updatedBefore
      in: query
      description: >-
        A pesquisa retorna registros atualizados até esta data passada no
        parâmetro. Formato (AAAA-MM-DD).
      schema:
        type: string
    updatedAfter:
      name: updatedAfter
      in: query
      description: >-
        A pesquisa retorna registros atualizados a partir desta data passada no
        parâmetro. Formato (AAAA-MM-DD).
      schema:
        type: string
  schemas:
    '429':
      description: >-
        hardLimit: O limite de requisições por hora foi ultrapassado. Tente
        novamente mais tarde / timeLimit: O limite de 1 minuto de processamento
        de requisição por hora foi atingido. Tente novamente mais tarde
    '500':
      description: Erro na API
    payment_v2:
      allOf:
        - $ref: '#/components/schemas/paymentBase'
        - type: object
          properties:
            total:
              type: number
            subtotal:
              type: number
    paymentBase:
      type: object
      properties:
        type:
          type: string
          enum:
            - pix
            - boleto
            - debito
            - credito
            - financiamento
            - other
        condition:
          type: object
          properties:
            name:
              type: string
              example: À vista
            quantityOfInstallments:
              type: number
              example: 1
            conditionType:
              type: string
              enum:
                - notUpdate
                - increase
                - decrease
            modifierType:
              type: string
              enum:
                - percentage
                - fixed
            value:
              type: number
              example: 10
        transactionStatus:
          type: string
          enum:
            - pending
            - pre_approved
            - approved
            - canceled
            - voided
            - failed
            - unknown
          example: pending
        transactionId:
          type: string
          example: AAABBB123AA
        authorizationNsu:
          type: string
          example: '123123'
        authorizationCode:
          type: string
          example: '123123'
        paidAt:
          type: string
          example: 2025-01-01T00:00
        creditCard:
          type: object
          properties:
            brand:
              type: string
              example: visa
            last4digits:
              type: string
              example: '1234'
            first6digits:
              type: string
              example: '123456'
            holderName:
              type: string
              example: John Doe
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````