---
title: "Listar cobranças"
method: GET
path: "/collections"
tags: ["Collection"]
---

# Listar cobranças

`GET /collections`

API responsável por listar cobranças

## Query parameters

- `pageSize` integer, required — Quantidade de cobranças por página
- `pageNumber` integer, required — Número da página
- `types` 'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX' — Boleto de cobrança
- `id` string — Id da cobrança
- `barcode` string — Código de barras
- `digitableLine` string — Linha digitavel
- `documentNumber` string — Número de documento da cobrança
- `ourNumber` string — Nosso número da cobrança
- `startCreatedAt` string — Data de criação mínima
- `endCreatedAt` string — Data de criação máxima
- `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
- `payer.name` string — Nome do pagador
- `payer.taxId` string — Documento do pagador
- `batchId` string — Id do lote
- `updatedAt` string — Data da atualização
- `startDueDate` string — Data de vencimento mínima
- `endDueDate` string — Data de vencimento máxima
- `startSettledAt` string — Data de liquidação mínima
- `endSettledAt` string — Data de liquidação máxima
- `badCredit.status` 'STARTING' | 'PROCESSING' | 'WARNING_PERIOD' | 'FAILED_TO_SEND' | 'CONFIRMED' | 'CANCELED' — Status da negativação
- `isAnticipated` string — Cobrança antecipada
- `cursor` Cursor
  - `previous` object
    - `href` string
    - `method` string
    - `type` string
  - `next` object
    - `href` string
    - `method` string
    - `type` string

## Headers

- `x-correlation-id` string

## Response `200`

Lista de cobranças

- CollectionsResponse
  - `data` CollectionResponse[]
    - `collectionId` string, required — Id da cobrança
    - `dueDate` string, date — Data do vencimento da cobrança
    - `overDueDate` string, date — Data de expiração da cobrança
    - `createdAt` string — Data da criação
    - `amount` number — Valor
    - `batchId` string — Id do lote
    - `deliveryMediums` string[]
    - `interest` Interest
      - `startDate` string, date
      - `type` 'FIXED_VALUE_PER_DAY' | 'PERCENTAGE_PER_MONTH' | 'NOT_APPLICABLE'
      - `value` number
    - `fine` Fine
      - `startDate` string, date — Data incial
      - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
      - `value` number
    - `discounts` Discount[]
      - `limitDate` string, date — Data limite
      - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
      - `value` number
    - `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
    - `type` 'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX' — Boleto de cobrança
    - `payee` Payee — Emissor
      - `document` string
      - `fantasyName` string — Nome
      - `socialName` string — Nome
      - `bankCode` string — Código bancário
      - `bankName` string — Nome
    - `payer` Payer — Pagador
      - `name` string, required
      - `email` string, email
      - `personType` 'F' | 'J', required
      - `phoneNumber` string
      - `taxId` string, required
      - `address` Address
        - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
        - `zipCode` string
        - `country` string
        - `state` string
        - `city` string
        - `street` string
        - `number` string
        - `complement` string
        - `neighborhood` string
      - `deliveryMediums` string[]
    - `description` string
    - `detail` Detail
      - `barCode` string — Código de barras
      - `digitableLine` string — Linha digitavel
      - `ourNumber` string — Nosso número da cobrança
      - `documentNumber` string — Número de documento da cobrança
      - `emv` string
      - `pixKey` string
      - `txId` string
      - `correlationId` string — Id de correlação da cobrança
      - `badCredit` BadCreditIssueDate — Informações de negativação para cobranças com type BANKSLIP ou BANKSLIP_QRCODE
        - `type` 'APPLICABLE' | 'NOT_APPLICABLE', required — Se NOT_APPLICABLE, o campo issueDate não deve ser informado
        - `issueDate` string — Data para negativar a cobrança
      - `automaticPix` AutomaticPix
        - `authorizationId` string, uuid — Id da autorização do Pix Automático
    - `tags` Tag[]
      - `key` string — Chave da tag
      - `value` string — Valor da tag
    - `updatedAt` string — Data da atualização
  - `_links` object
    - `next` CursorLink
      - `href` string — Link do cursor
      - `method` string — Método da api
      - `type` string — Tipo de resposta
    - `previous` CursorLink
      - `href` string — Link do cursor
      - `method` string — Método da api
      - `type` string — Tipo de resposta

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/versions/2a24d3da114c/schema)