O ledger (livro-razão) da ClearPago registra todos os movimentos financeiros confirmados da sua conta. Cada operação Pix que alcança um estado terminal de sucesso gera um lançamento com tipo, valor em centavos, referência à transação de origem e timestamp.O ledger é a fonte primária para:
Cálculo de saldo disponível.
Reconciliação financeira com o seu ERP ou planilha.
Auditoria de movimentações por período.
Suporte a devoluções (verificação do teto disponível).
Operações em estados não terminais (PENDING, DISPATCHED, PROVIDER_RESULT_UNKNOWN) ainda não geram lançamentos. O ledger só reflete resultados definitivos.
# Todos os créditos de abrilcurl "https://api.clearpago.com.br/api/pix/ledger?operation=credit&start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer <seu_api_token>"
# Todos os débitos, paginação por cursorcurl "https://api.clearpago.com.br/api/pix/ledger?operation=debit&limit=100&cursor=<cursor>" \ -H "Authorization: Bearer <seu_api_token>"
O saldo disponível é a diferença acumulada entre créditos e débitos no ledger. A plataforma é a fonte autoritativa.TODO: endpoint de saldo consolidado (GET /balance ou similar) — verificar existência com a equipe.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClearPago","description":"Documentação oficial da API Pix ClearPago — integração, referência e operações.","colors":{"primary":"#0f766e"},"logo":{"light":"https://mintcdn.com/clearpago/mSJ86kniaUbCKbT4/logo_lightmode.png?fit=max\u0026auto=format\u0026n=mSJ86kniaUbCKbT4\u0026q=85\u0026s=874e04286f63996eee39a525d0e88605","dark":"https://mintcdn.com/clearpago/mSJ86kniaUbCKbT4/logo_darkmode.png?fit=max\u0026auto=format\u0026n=mSJ86kniaUbCKbT4\u0026q=85\u0026s=b1d1e55f3c47423ae78c56d021c837f6"},"footer":{"socials":{}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clearpago","hasAudioNarration":false,"actualSubdomain":"clearpago","customDomains":["docs.clearpago.com"],"gitSource":{"type":"github","owner":"europixgopay","repo":"doc-clearpago","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21b6e8b246900909733949","collectionId":"d62e408a-61dd-4644-a467-75b991618918","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21b6e8b246900909733949:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Referência de API","count":17},{"language":"default","tag":"Guias","count":8},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Conceitos","count":6},{"language":"default","tag":"Introdução","count":5},{"language":"default","tag":"Cash-out","count":4},{"language":"default","tag":"Cash-in","count":3},{"language":"default","tag":"Refund","count":3},{"language":"default","tag":"Erros","count":3},{"language":"default","tag":"Go-live","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"ledger-and-reconciliation/ledger-overview","slug":"/ledger-and-reconciliation/ledger-overview","pageMetadata":{"title":"Ledger — Visão geral","description":"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.","href":"/ledger-and-reconciliation/ledger-overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`o-que-é-o-ledger`,children:`O que é o ledger`}),`\n`,_jsxs(_components.p,{children:[`O `,_jsx(_components.strong,{children:`ledger`}),` (livro-razão) da ClearPago registra todos os movimentos financeiros confirmados da sua conta. Cada operação Pix que alcança um estado terminal de sucesso gera um `,_jsx(_components.strong,{children:`lançamento`}),` com tipo, valor em centavos, referência à transação de origem e timestamp.`]}),`\n`,_jsxs(_components.p,{children:[`O ledger é a `,_jsx(_components.strong,{children:`fonte primária`}),` para:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Cálculo de saldo disponível.`}),`\n`,_jsx(_components.li,{children:`Reconciliação financeira com o seu ERP ou planilha.`}),`\n`,_jsx(_components.li,{children:`Auditoria de movimentações por período.`}),`\n`,_jsx(_components.li,{children:`Suporte a devoluções (verificação do teto disponível).`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`quando-lançamentos-são-criados`,children:`Quando lançamentos são criados`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Operação`}),_jsx(_components.th,{children:`Evento que dispara`}),_jsx(_components.th,{children:`Tipo de lançamento`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cash-in pago`}),_jsxs(_components.td,{children:[`Cash-in atinge `,_jsx(_components.code,{children:`PAID`})]}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Crédito`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cash-out confirmado`}),_jsxs(_components.td,{children:[`Cash-out atinge `,_jsx(_components.code,{children:`CONFIRMED`})]}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Débito`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Refund-in confirmado`}),_jsxs(_components.td,{children:[`Refund-in atinge `,_jsx(_components.code,{children:`CONFIRMED`})]}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Débito`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cash-out revertido`}),_jsxs(_components.td,{children:[`Cash-out atinge `,_jsx(_components.code,{children:`REVERSED`})]}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Crédito`})})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Operações em estados `,_jsx(_components.strong,{children:`não terminais`}),` (`,_jsx(_components.code,{children:`PENDING`}),`, `,_jsx(_components.code,{children:`DISPATCHED`}),`, `,_jsx(_components.code,{children:`PROVIDER_RESULT_UNKNOWN`}),`) ainda `,_jsx(_components.strong,{children:`não geram lançamentos`}),`. O ledger só reflete resultados definitivos.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`consultar-o-ledger`,children:`Consultar o ledger`}),`\n`,_jsx(Heading,{level:`3`,id:`listar-lançamentos`,children:`Listar lançamentos`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Todos os créditos de abril`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clearpago.com.br/api/pix/ledger?operation=credit\u0026start_date=2026-04-01\u0026end_date=2026-04-30\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer \u003cseu_api_token>\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Todos os débitos, paginação por cursor`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clearpago.com.br/api/pix/ledger?operation=debit\u0026limit=100\u0026cursor=\u003ccursor>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer \u003cseu_api_token>\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`detalhe-de-uma-entrada`,children:`Detalhe de uma entrada`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clearpago.com.br/api/pix/ledger/e5f6a7b8-c9d0-1234-efab-345678901234\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer \u003cseu_api_token>\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`parâmetros-de-consulta`,children:`Parâmetros de consulta`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parâmetro`}),_jsx(_components.th,{children:`Tipo`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`operation`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`credit`}),` ou `,_jsx(_components.code,{children:`debit`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`entry_type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Ex.: `,_jsx(_components.code,{children:`pix_cash_in_credit`}),`, `,_jsx(_components.code,{children:`pix_cash_out_debit`}),`, `,_jsx(_components.code,{children:`pix_cash_in_reversal_debit`}),`, `,_jsx(_components.code,{children:`pix_cash_out_reversal_credit`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`start_date`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`YYYY-MM-DD`})}),_jsxs(_components.td,{children:[`Data inicial `,_jsx(_components.strong,{children:`inclusiva`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`end_date`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`YYYY-MM-DD`})}),_jsxs(_components.td,{children:[`Data final `,_jsx(_components.strong,{children:`inclusiva`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Tamanho da página (máx. 100)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cursor`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Paginação por cursor (preferida para grandes volumes)`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`como-interpretar-uma-entrada`,children:`Como interpretar uma entrada`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"e5f6a7b8-c9d0-1234-efab-345678901234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"operation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"entry_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pix_cash_in_credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount_cents\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`15075`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-04-01T12:10:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Campo`}),_jsx(_components.th,{children:`Interpretação`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`operation: credit`})}),_jsx(_components.td,{children:`Entrada de valor na conta (recebimento ou reversão de envio).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`operation: debit`})}),_jsx(_components.td,{children:`Saída de valor da conta (envio ou devolução de recebimento).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`amount_cents: 15075`})}),_jsx(_components.td,{children:`R$ 150,75 em centavos.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`entry_type`})}),_jsx(_components.td,{children:`Tipo específico do lançamento.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`reconciliação-com-operações`,children:`Reconciliação com operações`}),`\n`,_jsx(_components.p,{children:`Para cruzar entradas do ledger com as transações correspondentes:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Use `,_jsx(_components.code,{children:`entry_type`}),` para identificar o tipo de operação.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`TODO: campo de referência ao cash-in/cash-out id na entrada do ledger`}),` — confirmar se existe campo `,_jsx(_components.code,{children:`transaction_id`}),` ou `,_jsx(_components.code,{children:`resource_id`}),` na resposta.`]}),`\n`,_jsxs(_components.li,{children:[`Compare `,_jsx(_components.code,{children:`amount_cents`}),` com `,_jsx(_components.code,{children:`value_cents`}),` dos webhooks recebidos.`]}),`\n`,_jsxs(_components.li,{children:[`Caso encontre divergência, use `,_jsx(_components.code,{children:`GET /api/pix/cash-in/{id}`}),` ou `,_jsx(_components.code,{children:`GET /api/pix/cash-out/{id}`}),` para consultar o estado atual.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`saldo-disponível`,children:`Saldo disponível`}),`\n`,_jsx(_components.p,{children:`O saldo disponível é a diferença acumulada entre créditos e débitos no ledger. A plataforma é a fonte autoritativa.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`TODO: endpoint de saldo consolidado (GET /balance ou similar)`}),` — verificar existência com a equipe.`]}),`\n`,_jsx(Heading,{level:`2`,id:`boas-práticas-de-fechamento`,children:`Boas práticas de fechamento`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Exporte o ledger `,_jsx(_components.strong,{children:`por período fechado`}),` (ex.: por dia) usando `,_jsx(_components.code,{children:`start_date`}),` e `,_jsx(_components.code,{children:`end_date`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Use `,_jsx(_components.strong,{children:`paginação por cursor`}),` para volumes grandes.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Não modifique`}),` entradas do ledger no seu sistema — elas são imutáveis.`]}),`\n`,_jsx(_components.li,{children:`Reconcilie diariamente com seu sistema financeiro interno para identificar divergências cedo.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`referências`,children:`Referências`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/list-ledger-entries`,children:`GET /api/pix/ledger`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/get-ledger-entry`,children:`GET /api/pix/ledger/`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/core-concepts/ledger-and-balance`,children:`Ledger e saldo (conceito)`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/ledger-and-reconciliation/reconciliation`,children:`Reconciliação`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Ledger — Visão geral","description":"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.","href":"/ledger-and-reconciliation/ledger-overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"O que é o ledger","slug":"o-que-é-o-ledger","depth":2,"children":[]},{"title":"Quando lançamentos são criados","slug":"quando-lançamentos-são-criados","depth":2,"children":[]},{"title":"Consultar o ledger","slug":"consultar-o-ledger","depth":2,"children":[{"title":"Listar lançamentos","slug":"listar-lançamentos","depth":3,"children":[]},{"title":"Detalhe de uma entrada","slug":"detalhe-de-uma-entrada","depth":3,"children":[]}]},{"title":"Parâmetros de consulta","slug":"parâmetros-de-consulta","depth":2,"children":[]},{"title":"Como interpretar uma entrada","slug":"como-interpretar-uma-entrada","depth":2,"children":[]},{"title":"Reconciliação com operações","slug":"reconciliação-com-operações","depth":2,"children":[]},{"title":"Saldo disponível","slug":"saldo-disponível","depth":2,"children":[]},{"title":"Boas práticas de fechamento","slug":"boas-práticas-de-fechamento","depth":2,"children":[]},{"title":"Referências","slug":"referências","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"clearpago","siteName":"ClearPago","title":"Ledger — Visão geral - ClearPago","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-23T18:50:50.136Z","originalFileLocation":"ledger-and-reconciliation/ledger-overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClearPago\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/clearpago/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/clearpago/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/clearpago/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/clearpago/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Ledger — Visão geral - ClearPago\">\u003cmeta data-mint-head property=\"og:description\" content=\"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClearPago\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clearpago.mintlify.app/_mintlify/api/og/v2?division=Ledger+e+Reconcilia%C3%A7%C3%A3o\u0026amp;title=Ledger+%E2%80%94+Vis%C3%A3o+geral\u0026amp;description=O+que+%C3%A9+o+ledger+da+ClearPago%2C+quando+lan%C3%A7amentos+s%C3%A3o+criados%2C+como+consultar+e+como+interpretar+cr%C3%A9ditos+e+d%C3%A9bitos.\u0026amp;theme=d304cf9661ece7b5262fc744\u0026amp;signature=4230275007b3c86d9d73ec0362a066b4bcc7944b36a1ffbee023c2be54475468\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Ledger — Visão geral - ClearPago\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clearpago.mintlify.app/_mintlify/api/og/v2?division=Ledger+e+Reconcilia%C3%A7%C3%A3o\u0026amp;title=Ledger+%E2%80%94+Vis%C3%A3o+geral\u0026amp;description=O+que+%C3%A9+o+ledger+da+ClearPago%2C+quando+lan%C3%A7amentos+s%C3%A3o+criados%2C+como+consultar+e+como+interpretar+cr%C3%A9ditos+e+d%C3%A9bitos.\u0026amp;theme=d304cf9661ece7b5262fc744\u0026amp;signature=4230275007b3c86d9d73ec0362a066b4bcc7944b36a1ffbee023c2be54475468\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/clearpago/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClearPago\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f766e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ledger-and-reconciliation/ledger-overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clearpago.com/#organization\",\"name\":\"ClearPago\",\"url\":\"https://docs.clearpago.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clearpago/mSJ86kniaUbCKbT4/logo_lightmode.png?fit=max\u0026auto=format\u0026n=mSJ86kniaUbCKbT4\u0026q=85\u0026s=874e04286f63996eee39a525d0e88605\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clearpago.com#website\",\"name\":\"ClearPago\",\"url\":\"https://docs.clearpago.com\",\"publisher\":{\"@id\":\"https://docs.clearpago.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview#webpage\",\"url\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview\",\"name\":\"Ledger — Visão geral\",\"description\":\"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\",\"dateModified\":\"2026-04-23T18:50:50.136Z\",\"isPartOf\":{\"@id\":\"https://docs.clearpago.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ClearPago\",\"item\":\"https://docs.clearpago.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ledger — Visão geral\",\"item\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview#article\",\"headline\":\"Ledger — Visão geral\",\"name\":\"Ledger — Visão geral\",\"description\":\"O que é o ledger da ClearPago, quando lançamentos são criados, como consultar e como interpretar créditos e débitos.\",\"url\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clearpago.com/ledger-and-reconciliation/ledger-overview#webpage\"},\"dateModified\":\"2026-04-23T18:50:50.136Z\",\"publisher\":{\"@id\":\"https://docs.clearpago.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clearpago.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClearPago\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ClearPago","nav":{"global":null,"groups":[{"group":"Início","pages":[{"title":"ClearPago — API Pix","href":"/index"}]},{"group":"Introdução","pages":[{"title":"Visão geral","href":"/getting-started/overview"},{"title":"Autenticação","href":"/getting-started/authentication"},{"title":"Quickstart","href":"/getting-started/quickstart"},{"title":"Ambientes, headers e convenções","href":"/getting-started/environments-and-headers"},{"title":"Checklist de primeira integração","href":"/getting-started/first-integration-checklist"}]},{"group":"Conceitos","pages":[{"title":"Arquitetura","href":"/core-concepts/architecture"},{"title":"Modelo de identidade","href":"/core-concepts/identity-model"},{"title":"Ciclo de vida das operações","href":"/core-concepts/transaction-lifecycle"},{"title":"Modelo de status","href":"/core-concepts/status-model"},{"title":"Idempotência e correlação","href":"/core-concepts/idempotency-and-correlation"},{"title":"Ledger e saldo","href":"/core-concepts/ledger-and-balance"}]},{"group":"Guias","pages":[{"title":"Receber Pix (Cash-in)","href":"/guides/receive-pix-cash-in"},{"title":"Enviar Pix por chave (Cash-out)","href":"/guides/send-pix-cash-out-key"},{"title":"Enviar Pix por QR Code (Cash-out QR)","href":"/guides/send-pix-cash-out-qrcode"},{"title":"Devolver um cash-in (Refund-in)","href":"/guides/refund-a-cash-in"},{"title":"Lidar com reversão de cash-out","href":"/guides/handle-cash-out-reversal"},{"title":"Registrar webhooks do comerciante","href":"/guides/register-merchant-webhooks"},{"title":"Verificar assinaturas de webhook","href":"/guides/verify-webhook-signatures"},{"title":"Reconciliar transações","href":"/guides/reconcile-transactions"}]},{"group":"Referência de API","pages":[{"group":"Cash-in","pages":[{"title":"POST /api/pix/cash-in","href":"/api-reference/create-cash-in"},{"title":"GET /api/pix/cash-in","href":"/api-reference/list-cash-ins"},{"title":"GET /api/pix/cash-in/{id}","href":"/api-reference/get-cash-in"}]},{"group":"Cash-out","pages":[{"title":"POST /api/pix/cash-out","href":"/api-reference/create-cash-out"},{"title":"GET /api/pix/cash-out","href":"/api-reference/list-cash-outs"},{"title":"GET /api/pix/cash-out/{id}","href":"/api-reference/get-cash-out"},{"title":"POST /api/pix/cash-out-qrcode","href":"/api-reference/create-cash-out-qrcode"}]},{"group":"Refund","pages":[{"title":"POST /api/pix/refund-in/{id}","href":"/api-reference/create-refund-in"},{"title":"GET /api/pix/refund","href":"/api-reference/list-refunds"},{"title":"GET /api/pix/refund/{id}","href":"/api-reference/get-refund"}]},{"group":"Ledger","pages":[{"title":"GET /api/pix/ledger","href":"/api-reference/list-ledger-entries"},{"title":"GET /api/pix/ledger/{id}","href":"/api-reference/get-ledger-entry"}]},{"group":"Organização","pages":[{"title":"GET /organization/balance","href":"/api-reference/get-balance"}]},{"group":"Transações","pages":[{"title":"List transactions cash in","href":"/api-reference/list-transactions-cash-in"},{"title":"List transactions cash out","href":"/api-reference/list-transactions-cash-out"}]},{"group":"Webhooks","pages":[{"title":"POST /webhook (registro de notificações)","href":"/api-reference/register-webhook"},{"title":"GET /webhook","href":"/api-reference/list-webhooks"},{"title":"DELETE /webhook/{webhook_id}","href":"/api-reference/delete-webhook"},{"title":"GET /public-key","href":"/api-reference/get-public-key"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks: parceiro → ClearPago","href":"/webhooks/partner-to-clearpago"},{"title":"Webhooks: ClearPago → comerciante","href":"/webhooks/clearpago-to-merchant"},{"title":"Referência de payloads (webhooks)","description":"Semântica de event_type, event.id, deduplicação, exemplos de comerciante e apêndice de parceiro.","href":"/webhooks/webhook-event-reference"}]},{"group":"Ledger e Reconciliação","pages":[{"title":"Ledger — Visão geral","href":"/ledger-and-reconciliation/ledger-overview"},{"title":"Reconciliação","description":"Por que existe reconciliação, quando ela é acionada, como o integrador deve agir e quando escalar.","href":"/ledger-and-reconciliation/reconciliation"},{"title":"Monitoramento operacional","href":"/ledger-and-reconciliation/operational-monitoring"}]},{"group":"Erros","pages":[{"title":"Tratamento de erros","href":"/errors/error-handling"},{"title":"Códigos, sintomas e ações","href":"/errors/error-codes"},{"title":"Troubleshooting","href":"/errors/troubleshooting"}]},{"group":"Go-live","pages":[{"title":"Checklist de produção","href":"/go-live/production-checklist"},{"title":"Checklist de segurança","href":"/go-live/security-checklist"},{"title":"Checklist de observabilidade","href":"/go-live/observability-checklist"}]},{"group":"FAQ","pages":[{"title":"Perguntas frequentes","href":"/faq/index"}]}]},"title":"Ledger — Visão geral - ClearPago","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}
