Fechamentos

Fechamento diário da unidade, feito pela conciliação com o extrato do banco: Pix recebidos, taxa, devoluções, MED e o líquido do dia (horário de Brasília). Publicado uma vez, quando o dia fecha sem divergência, e nunca muda depois; chega também pelo evento settlement.closed.

Listar fechamentos diários

GET /v1/settlements

Requer o escopo payments:read. Do mais recente para o mais antigo.

Parâmetros

Nome	Onde	Tipo	Descrição
`limit`	consulta	integer
`starting_after`	consulta	string	Cursor — ID do último objeto da página anterior.
`ending_before`	consulta	string	Cursor — ID do primeiro objeto da página seguinte.
`date_gte`	consulta	string (date)	Dia inicial (horário de Brasília), AAAA-MM-DD.
`date_lte`	consulta	string (date)	Dia final (horário de Brasília), AAAA-MM-DD.

Respostas

200 Lista paginada de fechamentos.
400 Requisição inválida (formato ou campos).
401 Chave ausente, inválida, expirada ou revogada.
403 Operação não permitida: escopo insuficiente (`insufficient-scope`), IP fora da lista permitida
429 Limite de requisições (`rate-limited`) ou cota diária de cobranças (`quota-exceeded`) excedidos.
500 Erro interno. É seguro repetir com a mesma `Idempotency-Key`.

Exemplo

curl -X GET "https://api.exemplo.com.br/v1/settlements?limit=20" \
  -H "Authorization: Bearer $PIX_API_KEY"

Identificador nos logs: api.settlements.list

Consultar fechamento diário

GET /v1/settlements/{settlement_id}

Requer o escopo payments:read.

Parâmetros

Nome	Onde	Tipo	Descrição
`settlement_id` obrigatório	caminho	string

Respostas

200 Fechamento.
401 Chave ausente, inválida, expirada ou revogada.
403 Operação não permitida: escopo insuficiente (`insufficient-scope`), IP fora da lista permitida
404 Recurso não encontrado (ou pertencente a outra unidade).
429 Limite de requisições (`rate-limited`) ou cota diária de cobranças (`quota-exceeded`) excedidos.
500 Erro interno. É seguro repetir com a mesma `Idempotency-Key`.

Exemplo

curl -X GET "https://api.exemplo.com.br/v1/settlements/st_01J9Z3F0A1B2C3D4E5F6G7H8J9" \
  -H "Authorization: Bearer $PIX_API_KEY"

Identificador nos logs: api.settlements.retrieve