Skip to main content

​
O que é o Ledger?

O Ledger é o registro contábil de todas as movimentações financeiras da sua conta Owem. Cada crédito, débito, taxa e estorno é registrado com detalhes completos para auditoria e conciliação.

Completo

Todas as movimentações em um só lugar.

Imutável

Registros não podem ser alterados após criação.

Detalhado

Informações completas de cada transação.

Filtros Avançados

Busque por tipo, status, data e identificadores.

​
Estrutura de uma Entrada

Cada entrada no Ledger contém:
CampoDescrição
idIdentificador único (Entry ID)
endToEndIdID PIX da transação (E2E)
externalIdSeu ID externo (para correlação)
typecredit ou debit
reasonMotivo da movimentação
statusStatus atual
grossAmountValor bruto
netAmountValor líquido (após taxas)
feeAmountValor da taxa
createdAtData/hora da criação

​
Tipos de Movimentação

​
Créditos (type: credit)

ReasonDescrição
pix_in:qrcode_paidPagamento de QR Code recebido
pix_in:refund_receivedEstorno de PIX OUT recebido
manual_creditCrédito manual (admin)

​
Débitos (type: debit)

ReasonDescrição
pix_out:processingTransferência PIX em processamento
pix_out:succeededTransferência PIX concluída
pix_in:refund_sentEstorno de PIX IN enviado
fee:transactionTaxa de transação

​
Status das Entradas

StatusDescrição
pendingAguardando processamento
processingEm processamento
succeededConcluída com sucesso
failedFalhou
refundedEstornada
cancelledCancelada

​
Extrato Bancário (PDF/CSV)

Além das consultas via API, o Ledger oferece a geração de extratos bancários completos em formato PDF ou CSV, com processamento assíncrono.

PDF

Relatório formatado com logo, cabeçalho, resumos e tabela de transações. Ideal para apresentação, contabilidade e auditoria.

CSV

Dados tabulares para importação em planilhas e sistemas. Ideal para contabilidade e conciliação automatizada.

​
Como Funciona

1

Solicitar Extrato

Envie um POST /v4/i/ledger/extract com a conta, período e formato desejado.
2

Aguardar Processamento

A API retorna 202 Accepted com um extractId. O processamento ocorre em background.
3

Consultar e Baixar

Use GET /v4/i/ledger/extract/{extractId} para acompanhar. Quando status for done, use o reportUrl para download.

​
Personalização

O extrato pode ser personalizado via o campo options: Seções do relatório (options.sections):
SeçãoDescrição
summaryResumo geral com totais de créditos, débitos e taxas
monthlyTableTabela com totais agrupados por mês
monthSummaryResumo detalhado por mês com breakdown por tipo
transactionTableTabela com todas as transações individuais
Colunas da tabela de transações (options.columns):
ColunaDescrição
dateTimeData e hora
typeTipo (Entrada/Saída)
descriptionDescrição
endToEndIdIdentificador E2E da transação PIX
payerReceiverNome, documento, agência e conta
payerBankInfoISPB e nome do banco
grossAmountValor bruto
feeTaxa
netAmountValor líquido
statusStatus da transação
Todas as seções e colunas são habilitadas por padrão. Envie false apenas para as que deseja ocultar.

​
Conciliação Financeira

O Ledger é a fonte de verdade para conciliação:
1

Exporte Movimentações

Use a API ou painel para exportar movimentações do período.
2

Compare com seu Sistema

Cruze os externalId com seus registros internos.
3

Identifique Divergências

Verifique transações presentes em um lado e não no outro.
4

Resolva Pendências

Investigue e corrija divergências encontradas.

​
Consultas Disponíveis

​
Por Filtros (Lista)

Busque múltiplas entradas com filtros: 
GET /v4/i/ledger?type=credit&status=succeeded&startDate=1735228800000
FiltroDescrição
typecredit ou debit
statusStatus da entrada
reasonMotivo da movimentação
startDateData inicial (epoch ms)
endDateData final (epoch ms)
pagePágina (paginação)
limitItens por página (máx 100)

​
Por Identificadores

EndpointBusca por
/ledger/external-id/{id}Seu ID externo
/ledger/end-to-end/{e2e}ID PIX (E2E)
/ledger/entry-id/{id}ID da entrada (Ledger)

​
Endpoints Relacionados

Listar Movimentações

GET /v4/i/ledger

Por External ID

GET /v4/i/ledger/external-id/{id}

Por End-to-End

GET /v4/i/ledger/end-to-end/{e2e}

Por Entry ID

GET /v4/i/ledger/entry-id/{id}

Gerar Extrato

POST /v4/i/ledger/extract

Consultar Extrato

GET /v4/i/ledger/extract/{id}

​
Exemplo de Entrada

{
  "id": "E37839059202512261234567890abcdef",
  "endToEndId": "E37839059202512261234567890abcdef",
  "externalId": "pedido-12345",
  "type": "credit",
  "reason": "pix_in:qrcode_paid",
  "status": "succeeded",
  "grossAmount": 100.0,
  "netAmount": 98.5,
  "feeAmount": 1.5,
  "payer": {
    "name": "MARIA SILVA",
    "cpfCnpj": "12345678901",
    "ispb": "00000000",
    "bankName": "Banco do Brasil"
  },
  "createdAt": "2025-12-26T15:30:45.000Z",
  "updatedAt": "2025-12-26T15:30:46.000Z"
}

​
Boas Práticas

Use externalId

Sempre inclua seu ID externo para facilitar conciliação.

Pagine Corretamente

Use paginação para grandes volumes de dados.

Cache de Consultas

Cache consultas frequentes para reduzir chamadas à API.

Concilie Diariamente

Faça conciliação diária para identificar problemas cedo.