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

# Listar Checkouts Transparentes

> Retorna todos os Checkouts Transparentes (QRCodes PIX) que você criou.

Você pode usar essa rota para listar todos os seus checkouts transparentes e visualizar seus status, valores e informações relacionadas.


Retorna as cobranças do checkout transparente da sua loja: PIX, Boleto e Cartão.

<Card horizontal>
  Requer a permissão `TRANSPARENT:READ`.
</Card>

Use `limit`, `after` e `before` para paginar e `startDate`/`endDate` (`YYYY-MM-DD`) para filtrar por data de criação. Consulte [Paginação e filtro por data](/pages/reference/introduction#paginação-e-filtro-por-data). Cada item segue o formato da resposta de criação do seu método: [PIX](/pages/transparents/create), [Boleto](/pages/transparents/boleto) ou [Cartão](/pages/transparents/card).

Para filtrar por método, use `method`. Por exemplo, só as cobranças de cartão:

```bash theme={null}
curl "https://api.abacatepay.com/v2/transparents/list?method=CARD&limit=20" \
  -H "Authorization: Bearer $ABACATEPAY_API_KEY"
```


## OpenAPI

````yaml GET /transparents/list
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /transparents/list:
    get:
      summary: Listar Checkouts Transparentes
      description: >
        Retorna todos os Checkouts Transparentes (QRCodes PIX) que você criou.


        Você pode usar essa rota para listar todos os seus checkouts
        transparentes e visualizar seus status, valores e informações
        relacionadas.
      parameters:
        - $ref: '#/components/parameters/QueryAfter'
        - $ref: '#/components/parameters/QueryBefore'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryStartDate'
        - $ref: '#/components/parameters/QueryEndDate'
        - name: id
          in: query
          description: Filtrar por identificador único do QRCode Pix
          required: false
          schema:
            type: string
            example: pix_char_123456
        - name: status
          in: query
          description: Filtrar por status do QRCode Pix
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - EXPIRED
              - CANCELLED
              - PAID
              - REFUNDED
        - name: externalId
          in: query
          description: Filtrar por identificador do Checkout Transparente no seu sistema
          required: false
          schema:
            type: string
        - name: method
          in: query
          description: Filtrar por método de pagamento
          required: false
          schema:
            type: string
            enum:
              - PIX
              - CARD
              - PIX_QRCODE
              - BOLETO
      responses:
        '200':
          description: Checkouts transparentes listados com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Lista de Checkouts Transparentes (QRCodes PIX).
                    items:
                      $ref: '#/components/schemas/PixQRCode'
                  success:
                    $ref: '#/components/schemas/Success'
                  error:
                    type: string
                    nullable: true
                    example: null
                  pagination:
                    $ref: '#/components/schemas/PaginationCursor'
        '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 na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  parameters:
    QueryAfter:
      name: after
      in: query
      description: >-
        Cursor para buscar itens após este ponto (use o `publicId` retornado em
        `pagination.next`).
      required: false
      schema:
        type: string
    QueryBefore:
      name: before
      in: query
      description: >-
        Cursor para buscar itens antes deste ponto (use o `publicId` retornado
        em `pagination.before`).
      required: false
      schema:
        type: string
    QueryLimit:
      name: limit
      in: query
      description: Quantidade de itens por página (1-100).
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 100
        example: 100
    QueryStartDate:
      name: startDate
      in: query
      description: >
        Filtra registros criados a partir desta data (inclusive). Formato
        `YYYY-MM-DD`. O intervalo é interpretado no fuso horário
        `America/Sao_Paulo` (00:00 do dia inicial).
      required: false
      schema:
        type: string
        format: date
        example: '2026-01-01'
    QueryEndDate:
      name: endDate
      in: query
      description: >
        Filtra registros criados até esta data (inclusive). Formato
        `YYYY-MM-DD`. O intervalo é interpretado no fuso horário
        `America/Sao_Paulo` (23:59:59.999 do dia final).
      required: false
      schema:
        type: string
        format: date
        example: '2026-01-31'
  schemas:
    PixQRCode:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do QRCode Pix.
          example: pix_char_123456
        amount:
          type: number
          description: Valor a ser pago.
          example: 100
        status:
          type: string
          description: Informação sobre o andamento do QRCode Pix.
          enum:
            - PENDING
            - EXPIRED
            - CANCELLED
            - PAID
            - UNDER_DISPUTE
            - REFUNDED
            - REDEEMED
            - APPROVED
            - FAILED
          example: PENDING
        devMode:
          type: boolean
          description: Ambiente no qual o QRCode Pix foi criado.
          example: true
        brCode:
          type: string
          description: Código copia-e-cola do QRCode Pix.
          example: 00020101021226950014br.gov.bcb.pix
        brCodeBase64:
          type: string
          description: Imagem em Base64 do QRCode Pix.
          example: data:image/png;base64,iVBORw0KGgoAAA
        platformFee:
          type: number
          description: Taxas da plataforma
          example: 80
        receiptUrl:
          type: string
          format: uri
          nullable: true
          description: >-
            URL do comprovante de pagamento. Preenchido após o pagamento ser
            confirmado; `null` enquanto a cobrança estiver pendente.
          example: null
        createdAt:
          type: string
          description: Data de criação do QRCode Pix.
          example: '2025-03-24T21:50:20.772Z'
        updatedAt:
          type: string
          description: Data de atualização do QRCode Pix.
          example: '2025-03-24T21:50:20.772Z'
        expiresAt:
          type: string
          description: Data de expiração do QRCode Pix
          example: '2025-03-25T21:50:20.772Z'
        metadata:
          type: object
          description: Metadados opcionais da cobrança.
          additionalProperties: true
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
    PaginationCursor:
      type: object
      description: Informações de paginação baseada em cursor.
      required:
        - hasMore
        - next
        - before
      additionalProperties: false
      properties:
        hasMore:
          type: boolean
          description: Indica se existe uma próxima página.
        next:
          type: string
          nullable: true
          description: Cursor da próxima página (usar em `after`). `null` na última página.
        before:
          type: string
          nullable: true
          description: >-
            Cursor da página anterior (usar em `before`). `null` na primeira
            página.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.