---
title: "Listar lotes de pagamento"
method: GET
path: "/{companyId}/banking/payroll/payments"
tags: ["Pagamentos"]
---

# Listar lotes de pagamento

`GET /{companyId}/banking/payroll/payments`

Retorna lista paginada dos lotes de pagamento da empresa com filtros opcionais. Paginação por cursor: use o valor de `_links.next.href` para navegar entre páginas.

**Nota:** A listagem aplica filtro implícito por janela de tempo. Pagamentos fora da janela padrão podem não aparecer mesmo após liquidação. Use `startDate` e `endDate` para ampliar o período de busca.

## Path parameters

- `companyId` string, required

## Query parameters

- `companyTaxIds` string[]
- `pageSize` integer
- `cursor` string
- `startDate` string, date-time
- `endDate` string, date-time
- `reference` string
- `status` integer[]
- `unitPayment` boolean
- `recurrenceId` integer

## Response `200`

OK

- PayrollListResponseDto
  - `links` PayrollLinksDto
    - `next` PayrollLinkDto
      - `href` string, nullable
    - `prev` PayrollLinkDto
      - `href` string, nullable
  - `data` PayrollListItemDto[], nullable
    - `requestId` string, nullable
    - `requester` string, nullable
    - `paymentId` integer
    - `paymentTypeId` integer
    - `reference` string, nullable
    - `scheduledDate` string, nullable
    - `debitDate` string, nullable
    - `receiptDate` string, nullable
    - `validatedAmount` number, double
    - `status` string, nullable
    - `paymentType` string, nullable
    - `errorMessage` string, nullable
    - `cancellationMessage` string, nullable
    - `originalAmount` number, double
    - `paidAmount` number, double
    - `errorTransferCount` integer
    - `company` PayrollCompanyDto
      - `name` string, nullable
      - `taxId` string, nullable
      - `account` PayrollAccountDto
        - `branch` string, nullable
        - `number` string, nullable
    - `links` PayrollItemLinksDto
      - `self` PayrollLinkDto
        - `href` string, nullable

---

[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/revisions/2a24d3da114c/schema)
