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

# Listar Cobranças

> Lista as cobranças do merchant com filtros opcionais.

Lista as cobranças do merchant com paginação por cursor e filtros opcionais.

## Filtros

| Filtro             | Aceita                                   | Exemplo                          |
| ------------------ | ---------------------------------------- | -------------------------------- |
| `id`               | ID de uma cobrança específica            | `?id=chg_018f8e2d9a5f7b10c3d4`   |
| `email`            | E-mail do customer associado             | `?email=joao@exemplo.com`        |
| `status`           | `PENDING`, `PAID`, `EXPIRED`, `REFUNDED` | `?status=PAID`                   |
| `after` / `before` | Cursor opaco retornado em `pagination`   | `?after=eyJjcmVhdGVkQXQiOi4uLn0` |
| `limit`            | 1 a 100 (padrão 20)                      | `?limit=50`                      |

## Exemplos

```bash theme={null}
# Cobranças pagas
GET /transparents/list?status=PAID&limit=50

# Cobranças de um cliente pelo e-mail
GET /transparents/list?email=joao@exemplo.com

# Próxima página
GET /transparents/list?after=eyJjcmVhdGVkQXQiOi4uLn0
```

**Resposta:**

```json theme={null}
{
  "data": [
    {
      "id": "chg_018f8e2d9a5f7b10c3d4",
      "amount": 5000,
      "status": "PAID",
      "txid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f",
      "brCode": "00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD",
      "expiresAt": "2026-04-19T19:02:11.420Z",
      "paidAt": "2026-04-19T18:34:55.000Z",
      "customer": {
        "id": "cust_018f3a2b7c4d7c40a1b2",
        "name": "João Silva",
        "taxId": "12345678900",
        "email": "joao@exemplo.com"
      },
      "createdAt": "2026-04-19T18:32:11.420Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "next": null,
    "before": null
  },
  "error": null,
  "success": true
}
```

<Tip>
  A listagem **não** retorna o `imageBase64` — esse campo só aparece em
  [`GET /transparents/check`](/pages/transparents/get) ou na resposta do
  `POST /transparents/create`.
</Tip>


## OpenAPI

````yaml GET /transparents/list
openapi: 3.1.0
info:
  title: API Liquerapay
  description: |
    API pública da Liquerapay para criar cobranças PIX, processar saques,
    gerenciar clientes e receber eventos via webhooks.

    ## Versão Beta

    A v1 está em **beta**. Endpoints e payloads podem sofrer pequenas
    alterações antes da versão estável (1.0). Recomendamos travar a versão
    da sua integração no `package.json` / `requirements.txt` enquanto
    estivermos em beta.

    Não há ambiente de sandbox — todas as chamadas acontecem contra o
    ambiente de produção.

    ## Como começar

    1. Crie sua conta em [app.liquerapay.com](https://app.liquerapay.com)
    2. Gere uma chave de API no painel (`liq_...`)
    3. Faça sua primeira chamada em `https://api.liquerapay.com`
  version: 1.0.0-beta
  contact:
    name: Suporte Liquerapay
    url: https://liquerapay.com
  license:
    name: Proprietary
servers:
  - url: https://api.liquerapay.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Cadastre e gerencie os clientes da sua loja para reutilizar em cobranças.
  - name: Checkout Transparente
    description: >-
      Crie cobranças PIX (QR Code copia-e-cola) direto pela API e gerencie
      devoluções.
  - name: Withdrawals
    description: Solicite saques do saldo disponível para uma chave PIX.
  - name: Webhooks
    description: Cadastre URLs para receber eventos da Liquerapay em tempo real.
paths:
  /transparents/list:
    get:
      tags:
        - Checkout Transparente
      summary: Listar cobranças
      description: Lista as cobranças do merchant com filtros opcionais.
      parameters:
        - $ref: '#/components/parameters/After'
        - $ref: '#/components/parameters/Before'
        - $ref: '#/components/parameters/Limit'
        - name: id
          in: query
          required: false
          description: Filtra por ID exato da cobrança.
          schema:
            type: string
            example: chg_018f8e2d9a5f7b10c3d4
        - name: email
          in: query
          required: false
          description: Filtra por e-mail do customer associado.
          schema:
            type: string
            example: joao@exemplo.com
        - name: status
          in: query
          required: false
          description: Filtra por status da cobrança.
          schema:
            $ref: '#/components/schemas/ChargeStatus'
      responses:
        '200':
          description: Lista paginada de cobranças.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    After:
      name: after
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.next` da resposta anterior) para
        buscar a página seguinte.
      schema:
        type: string
    Before:
      name: before
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.before` da resposta anterior) para
        buscar a página anterior.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      required: false
      description: Quantidade máxima de itens por página (1 a 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    ChargeStatus:
      type: string
      enum:
        - PENDING
        - PAID
        - EXPIRED
        - REFUNDED
        - DISPUTED
      description: |
        - `PENDING`: QR Code emitido, aguardando pagamento
        - `PAID`: pagamento confirmado
        - `EXPIRED`: passou do tempo limite sem pagamento
        - `REFUNDED`: cobrança paga foi devolvida integralmente
        - `DISPUTED`: há uma infração/MED aberta contra o pagamento
      example: PAID
    ChargeListResponse:
      type: object
      required:
        - data
        - pagination
        - error
        - success
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ChargeListItem'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    ChargeListItem:
      type: object
      required:
        - id
        - amount
        - status
        - txid
        - brCode
        - createdAt
      properties:
        id:
          type: string
          example: chg_018f8e2d9a5f7b10c3d4
        amount:
          type: integer
          example: 5000
        status:
          $ref: '#/components/schemas/ChargeStatus'
        txid:
          type: string
          example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f
        brCode:
          type: string
          example: 00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD
        expiresAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-19T19:02:11.420Z'
        paidAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-19T18:34:55.000Z'
        customer:
          allOf:
            - $ref: '#/components/schemas/CustomerSummary'
          nullable: true
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T18:32:11.420Z'
    CursorPagination:
      type: object
      required:
        - hasMore
        - next
        - before
      description: |
        Metadados de paginação bidirecional (usado por Checkout Transparente
        e Webhooks). `next`/`before` são cursores opacos — passe-os de volta
        em `after`/`before` para navegar.
      properties:
        hasMore:
          type: boolean
          description: Indica se existem mais itens após esta página.
          example: true
        next:
          type: string
          nullable: true
          description: Cursor para a próxima página, ou `null` se for a última.
          example: eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTE5In0
        before:
          type: string
          nullable: true
          description: Cursor para a página anterior, ou `null` se for a primeira.
          example: null
    Error:
      type: object
      required:
        - error
        - message
        - success
      properties:
        error:
          type: string
          description: >-
            Código do erro (ex.: `VALIDATION_ERROR`, `UNAUTHORIZED`,
            `NOT_FOUND`).
          example: VALIDATION_ERROR
        message:
          type: string
          description: Mensagem amigável descrevendo o erro.
          example: 'amount: deve ser um número inteiro positivo'
        success:
          type: boolean
          enum:
            - false
          example: false
    CustomerSummary:
      type: object
      required:
        - id
        - name
        - taxId
        - email
      description: Customer resumido, anexado a uma cobrança.
      properties:
        id:
          type: string
          example: cust_018f3a2b7c4d7c40a1b2
        name:
          type: string
          example: João Silva
        taxId:
          type: string
          description: CPF ou CNPJ (apenas números).
          example: '12345678900'
        email:
          type: string
          example: joao@exemplo.com
        phone:
          type: string
          nullable: true
          example: '+5511999999999'
  responses:
    Unauthorized:
      description: Falha de autenticação (token inválido, ausente ou revogado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Token inválido ou ausente
            success: false
    Forbidden:
      description: Acesso negado para esta operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: FORBIDDEN
            message: Saques estão temporariamente bloqueados para este merchant
            success: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key ou JWT
      description: |
        Autentique suas requisições enviando o token no header
        `Authorization: Bearer <token>`.

        O token pode ser:

        - Uma **API key** com prefixo `liq_`, gerada em
          [Dashboard Liquerapay → Configurações → API Keys](https://app.liquerapay.com).
        - Um **JWT** retornado pelo login do dashboard (uso interno).

        Não há distinção de ambiente — toda chave vale para o único
        ambiente disponível (produção).

````