Listar lotes de pagamento

get

https://api.sandbox.empresas.btgpactual.com/{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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Query Params

companyTaxIds

array of strings

CNPJs das empresas (14 dígitos, sem formatação). Aceita múltiplos valores.

companyTaxIds

pageSize

int32

Defaults to 20

Quantidade de itens por página (default 20, máximo 50)

cursor

string

Token opaco de cursor para paginação. Ausente na primeira requisição. Extrair de _links.next.href. Não construir manualmente.

startDate

date-time

Data de início do filtro (YYYY-MM-DD)

endDate

date-time

Data de fim do filtro (YYYY-MM-DD)

reference

string

Filtrar por referência/nome do lote

status

array of int32s

Filtrar por status do lote de pagamento

status

unitPayment

boolean

Defaults to false

Filtrar por pagamento individual (true) ou lote (false)

recurrenceId

int32

Filtrar por ID de recorrência

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK