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

# Listar cobranças

> Listar todas as cobranças criadas



## OpenAPI

````yaml openapi.yaml get /charges
openapi: 3.1.0
info:
  title: API AobaPay
  description: API para gerenciamento de cobranças e pagamentos usando o AobaPay.
  version: 1.0.0
servers:
  - url: https://api.aobapay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /charges:
    get:
      summary: Listar cobranças
      description: Listar todas as cobranças criadas
      parameters:
        - name: startDate
          in: query
          schema:
            type: string
            format: date
            description: Data de início no formato YYYY-MM-DD
            example: '2025-01-01'
        - name: endDate
          in: query
          schema:
            type: string
            format: date
            description: Data de término no formato YYYY-MM-DD
            example: '2025-12-31'
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: Ordenar por campo (id, createdAt)
            example: createdAt
        - name: order
          in: query
          required: false
          schema:
            type: string
            description: Ordenar em ordem (asc, desc)
            example: desc
      responses:
        '200':
          description: Lista de cobranças retornada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargesList'
        '400':
          description: Requisição inválida. Dados fornecidos são inválidos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro descrevendo o motivo da falha.
                    example: Data inicial deve estar no formato Y-m-d
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 400
                  data:
                    type: array
                    example: []
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro descrevendo o motivo da falha.
                    example: Header com Authorization está vazio
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 401
                  data:
                    type: array
                    example: []
      security:
        - bearerAuth: []
components:
  schemas:
    ChargesList:
      type: object
      properties:
        error:
          type: 'null'
        status:
          type: integer
          example: 200
        data:
          type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Charges'
            meta:
              type: object
              properties:
                current_page:
                  type: integer
                  example: 1
                last_page:
                  type: integer
                  example: 1
                per_page:
                  type: integer
                  example: 10
                total:
                  type: integer
                  example: 1
    Charges:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do QRCode Pix.
          example: ch_123456
        externalID:
          type: string
          description: Identificador único do QRCode Pix no seu sistema.
          example: pedido-123
        brCode:
          type: string
          description: Código copia-e-cola do QRCode Pix.
          example: 00020001021226950014br.gov.bcb.pix
        brCodeImageUrl:
          type: string
          description: Imagem em Base64 do QRCode Pix.
          example: https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8b
        amount:
          type: number
          description: Valor a ser pago.
          example: 200
        comment:
          type: string
          description: Comentário opcional sobre o QRCode Pix.
          example: 'Pagamento para pedido #123'
        expiration:
          type: integer
          description: Data de expiração do QRCode Pix em segundos.
          example: 300
        fee:
          type: number
          description: Taxas da plataforma
          example: 78
        expiresAt:
          type: string
          description: Data de expiração do QRCode Pix.
          example: '2025-09-25 13:07:27'
        status:
          type: string
          description: Informação sobre o andamento do QRCode Pix.
          enum:
            - PENDING
            - EXPIRED
            - FAILED
            - PAID
            - REFUNDED
          example: PENDING
        customer:
          type: object
          description: Dados do cliente associado ao QRCode Pix.
          additionalProperties: false
          properties:
            id:
              type: string
              description: Identificador único do cliente.
              example: cus_2243f989-f044-49cc-84db-3ff9e4908dde
            name:
              type: string
              description: Nome do cliente.
              example: João da Silva
            document:
              type: string
              description: Documento do cliente (CPF ou CNPJ).
              example: '12345678900'
            email:
              type: string
              description: Endereço de e-mail do cliente.
              example: brendo.silva@example.com
            phone:
              type: string
              description: Número de telefone do cliente.
              example: '+5511987654321'
        createdAt:
          type: string
          description: Data de criação do QRCode Pix.
          example: '2025-09-25 13:07:27'
        updatedAt:
          type: string
          description: Data de atualização do QRCode Pix.
          example: '2025-09-25 13:07:27'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <aobapay-api-key>`
        onde `<aobapay-api-key>` é a sua chave de API.

````