Autenticação: obrigatória — JWT via
Authorization: Bearer <access_token>. O usuário precisa ter acesso à account_id ou ser superusuário.kind=IN, crédito) ou uma saída (kind=OUT, débito), possui um valor em centavos de BRL, um status, e referencia a origem que o gerou: um recebível, um pagamento de boleto ou uma transferência.
Este endpoint retorna os lançamentos pertencentes à conta virtual informada, ordenados por created_at decrescente. Lançamentos com status CANCELED ou PREDICTED são omitidos da listagem — são ruídos contábeis sem efeito no saldo apresentado. A resposta é paginada.
Pré-requisitos
- A conta virtual existe e pertence à
account_id. Utilize o endpoint de listagem/detalhe de contas virtuais antes.
Parâmetros de caminho
Identificador unificado da conta do vendedor.
Identificador da conta virtual.
Parâmetros de query
Busca case-insensitive sobre o campo
name do lançamento.Resposta
Identificador do lançamento.
IN (crédito / entrada) ou OUT (débito / saída).Rótulo legível, por exemplo
"Pagamento de boleto" ou "PIX para Ada Lovelace".Valor em centavos de BRL. Sempre positivo — o sinal é determinado por
kind.Um entre
PLANNED, SCHEDULED, PAID, WAITING_CONFIRMATION, REVERSED, FAILED, UNKNOWN. A listagem omite CANCELED e PREDICTED.Texto livre com a razão do status quando ele é terminal e malsucedido (por exemplo,
"Saldo insuficiente").Exportação
Há também a ação de exportação:id, nome, valor (assinado, decimal com vírgula como separador, dividido por 100), status, motivo status, criado_em, atualizado_em. Escolha o formato pelo cabeçalho Accept (text/csv, application/vnd.ms-excel, text/plain).
Erros
| Status | Quando |
|---|---|
401 | Token ausente ou inválido. |
403 | O usuário não tem acesso à account_id. |
404 | A conta virtual não existe. |