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

# List Payments

> Lists payments.



## OpenAPI

````yaml /api-reference/customer/openapi.json get /api/v1/customer/payments
openapi: 3.0.0
info:
  title: DEVMOB Customer API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Address
    description: Customer addresses
  - name: Auth
    description: Authentication and token lifecycle
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Checkout
    description: Checkout creation and retrieval
  - name: Credit Grant
    description: Customer credits
  - name: Invite
    description: Invitation preview and acceptance
  - name: Notification
    description: Customer inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Customer orders
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Payment Method
    description: Saved payment methods
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated customer profile
  - name: Promotion
    description: Promotions
  - name: Routing
    description: Routing helpers
  - name: Session
    description: Authenticated sessions
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Ticket
    description: Customer tickets
  - name: Trip
    description: Customer trip access
  - name: Trip Review
    description: Trip reviews
paths:
  /api/v1/customer/payments:
    get:
      tags:
        - Payment
      summary: List Payments
      description: Lists payments.
      operationId: listPayments
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            default: 10
            description: Items per page
            example: 10
            type: number
        - name: page
          required: false
          in: query
          schema:
            default: 1
            description: Page number
            example: 1
            type: number
        - name: status
          required: false
          in: query
          schema:
            description: Payment status
            type: string
            enum:
              - ANTIFRAUD_APPROVED
              - ANTIFRAUD_MANUAL
              - ANTIFRAUD_PENDING
              - ANTIFRAUD_REPROVED
              - CANCELED
              - CHARGEDBACK
              - OVERPAID
              - PAID
              - PARTIAL_CANCELED
              - PAYMENT_FAILED
              - PENDING
              - PROCESSING
              - REFUNDED
              - UNDERPAID
            example: PENDING
        - name: sortBy
          required: false
          in: query
          schema:
            default: createdAt
            description: Field to sort by
            example: createdAt
            type: string
            enum:
              - createdAt
              - paidAt
              - amount
        - name: sortOrder
          required: false
          in: query
          schema:
            default: desc
            description: Sort order
            example: desc
            type: string
            enum:
              - asc
              - desc
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
                  meta:
                    $ref: '#/components/schemas/PageMeta'
                required:
                  - data
                  - meta
          description: OK
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
components:
  schemas:
    Payment:
      type: object
      properties:
        paymentId:
          type: string
          format: uuid
          description: Identificador único
        orderId:
          type: string
          format: uuid
          description: Referência ao pedido (relação 1:1)
        organizationId:
          type: string
          format: uuid
          description: Referência à organização da empresa beneficiária
        companyId:
          type: string
          format: uuid
          description: Referência à empresa beneficiária
        externalProvider:
          type: string
          description: Nome do provedor externo de pagamento
        externalProviderId:
          type: string
          description: ID da transação no provedor externo
        description:
          type: string
          nullable: true
          description: Descrição do pagamento
        method:
          type: string
          enum:
            - CASH
            - PIX
            - CREDIT_CARD
            - DEBIT_CARD
          description: Método de pagamento
        channel:
          type: string
          enum:
            - ONLINE
            - POS
          description: Canal em que o pagamento foi criado
        card:
          type: object
          additionalProperties: true
          nullable: true
          description: Metadados do cartão (quando aplicável)
        pix:
          type: object
          additionalProperties: true
          nullable: true
          description: Metadados do PIX (quando aplicável)
        amount:
          type: integer
          description: Valor do pagamento em centavos
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: Data de vencimento
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - ANTIFRAUD_PENDING
            - ANTIFRAUD_MANUAL
            - ANTIFRAUD_APPROVED
            - ANTIFRAUD_REPROVED
            - PAID
            - UNDERPAID
            - OVERPAID
            - PARTIAL_CANCELED
            - CANCELED
            - PAYMENT_FAILED
            - REFUNDED
            - CHARGEDBACK
          description: Status do pagamento
        issuedAt:
          type: string
          format: date-time
          description: Data de emissão
        paidAt:
          type: string
          format: date-time
          nullable: true
          description: Data em que o pagamento foi confirmado
        overdueAt:
          type: string
          format: date-time
          nullable: true
          description: Data em que o pagamento ficou vencido
        canceledBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que cancelou o pagamento, quando aplicável
        canceledAt:
          type: string
          format: date-time
          nullable: true
          description: Data de cancelamento
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
      required:
        - paymentId
        - orderId
        - organizationId
        - companyId
        - externalProvider
        - externalProviderId
        - description
        - method
        - channel
        - card
        - pix
        - amount
        - dueDate
        - status
        - issuedAt
        - paidAt
        - overdueAt
        - canceledBy
        - canceledAt
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
      description: Pagamento único associado a um pedido
    PageMeta:
      type: object
      properties:
        limit:
          type: integer
          description: Items per page.
          example: 10
        page:
          type: integer
          description: Current page.
          example: 1
        totalItems:
          type: integer
          description: Total items.
          example: 142
        totalPages:
          type: integer
          description: Total pages.
          example: 15
      required:
        - limit
        - page
        - totalItems
        - totalPages
      description: Page-based pagination metadata.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````