> ## Documentation Index > Fetch the complete documentation index at: https://nexus-docs.ticto.dev/llms.txt > Use this file to discover all available pages before exploring further. # Consultar extrato financeiro consolidado > Retorna o extrato financeiro paginado no mesmo formato apresentado na aba "Extrato Financeiro" do painel do vendedor: cada movimentação traz a descrição do lançamento já traduzida (ex.: "Comissão de Produtor", "Reembolso", "Saque"), a natureza da operação (`credit`/`debit`/`neutral`), a data de liberação, o produto e o saldo total após o evento. É uma visão apresentável e complementar ao extrato bruto (`/financial/account-statement`), que continua disponível com os eventos detalhados e o saldo consolidado. A descrição (`description`) é localizada pelo header `Accept-Language` (`pt-BR` padrão, `en`, `es`); para lógica de integração, use os campos estáveis `entry_type` e `operation`. O resultado é cacheado por 10 minutos por conta/filtros. ## OpenAPI ````yaml /api-reference/openapi.yaml get /financial/statement openapi: 3.0.3 info: title: Nexus version: 1.0.2 description: > API para integração entre Ticto e clientes externos # Autenticação Para autenticar as solicitações aos endpoints descritos a seguir, por favor, siga os passos abaixo: 1. **Solicite** seu cadastro como cliente através do e-mail **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`. 2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu `client_token`. 3. **Em todas as outras requisições**, envie seu `client_token` no header como `X-Api-Client-Token`. 4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário, será retornado um `public_token` único. 5. **Para endpoints que não estão em public.php**, adicione o `public_token` do usuário no cabeçalho **Authorization** utilizando o formato: ```http Authorization: Bearer {public_token} ``` ## Restrição de origem O acesso a esta API não está disponível para todos os sellers. Seu uso é estritamente permitido para parceiros comerciais que a utilizarão em cenários específicos. Por este motivo, o acesso será restrito a endereços IP e domínios previamente informados por esses parceiros. Essa medida visa proporcionar um ambiente mais controlado e seguro para todos os nossos usuários e parceiros. ### O que isso significa para os desenvolvedores? - **Acesso Limitado:** Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada. - **Processo de Autorização:** Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte. - **Como Solicitar Acesso:** Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo: - Nome da empresa ou do desenvolvedor - Endereços IP ou domínios a serem autorizados - Justificativa para o acesso - Informações de contato para eventuais esclarecimentos ## Alterações e/ou inclusão de novos domínios e IPs Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam feitas o mais breve possível para garantir uma transição suave. Em casos de alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados após sua remoção. ## Suporte e Dúvidas Para dúvidas ou suporte adicional, entre em contato conosco através do e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste processo e garantir a melhor experiência possível. servers: - url: https://nexus.ticto.com.br/api/v1 description: Produção security: [] tags: - name: Autenticação - name: Configurações do Cliente - name: Usuários - name: Onboarding de usuário - name: Contas Bancárias - name: Faixas de Taxa description: >- Endpoints para consulta de faixas de taxa personalizadas e histórico de alterações. - name: Frete - name: Financeiro - name: PIX Automático description: >- Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX Automático (débito recorrente autorizado pelo pagador). - name: Produtos - name: Integrações - name: 'Webhooks: Usuários' description: Eventos relacionados a cadastro e atualização de usuários. - name: 'Webhooks: Contas Bancárias' description: Eventos relacionados a contas bancárias dos sellers. - name: 'Webhooks: Produtos e Ofertas' description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores. - name: 'Webhooks: Financeiro' description: Eventos de reembolso, saque e antecipação. - name: 'Webhooks: Faixas de Taxa' description: Eventos de criação, atualização e exclusão de faixas de taxa. - name: 'Webhooks: Pedidos' description: Eventos de criação e atualização de pedidos. - name: 'Webhooks: Cobranças' description: >- Eventos de criação e mudança de status de cobranças (transações), na primeira compra e nas renovações. - name: 'Webhooks: Assinaturas' description: Eventos do ciclo de vida de assinaturas, cobranças e trial. paths: /financial/statement: get: tags: - Financeiro summary: Consultar extrato financeiro consolidado description: > Retorna o extrato financeiro paginado no mesmo formato apresentado na aba "Extrato Financeiro" do painel do vendedor: cada movimentação traz a descrição do lançamento já traduzida (ex.: "Comissão de Produtor", "Reembolso", "Saque"), a natureza da operação (`credit`/`debit`/`neutral`), a data de liberação, o produto e o saldo total após o evento. É uma visão apresentável e complementar ao extrato bruto (`/financial/account-statement`), que continua disponível com os eventos detalhados e o saldo consolidado. A descrição (`description`) é localizada pelo header `Accept-Language` (`pt-BR` padrão, `en`, `es`); para lógica de integração, use os campos estáveis `entry_type` e `operation`. O resultado é cacheado por 10 minutos por conta/filtros. operationId: getFinancialStatement parameters: - name: page in: query required: false description: Página da listagem (padrão 1) schema: type: integer minimum: 1 example: 1 - name: filter[betweenDates] in: query required: false description: > Intervalo de datas para filtrar as movimentações no formato `DD/MM/YYYY,DD/MM/YYYY` (data inicial e final separadas por vírgula). schema: type: string pattern: ^\d{2}\/\d{2}\/\d{4},\d{2}\/\d{2}\/\d{4}$ example: 01/07/2026,31/07/2026 - name: include_release in: query required: false description: | Quando `1`, inclui no extrato os lançamentos de liberação de saldo (`MONEY_RELEASED`), de ajuste (`BALANCE_ADJUSTMENT`) e de auditoria (`STATEMENT_AUDIT`), que por padrão ficam de fora — assim como no painel do vendedor. Nesse modo os lançamentos de `MONEY_UNBLOCKED` não são retornados. schema: type: integer enum: - 0 - 1 default: 0 example: 1 responses: '200': description: Extrato financeiro retornado com sucesso content: application/json: schema: $ref: '#/components/schemas/ResponseFinancialStatement' '400': description: >- Requisição inválida (ex.: contexto de carteira ausente ou filtro com formato incorreto) '401': description: Não autorizado '500': description: Erro interno do servidor security: - ApiClientToken: [] - bearerAuth: [] components: schemas: ResponseFinancialStatement: type: object required: - status - message - data properties: status: type: string example: success message: type: string example: Recurso retornado com sucesso data: type: object required: - statements - pagination properties: statements: type: array description: Movimentações ordenadas da mais recente para a mais antiga items: $ref: '#/components/schemas/FinancialStatementItem' pagination: $ref: '#/components/schemas/AccountStatementPagination' FinancialStatementItem: type: object description: Movimentação individual do extrato financeiro consolidado properties: movement_date: type: string nullable: true description: Data e hora da movimentação (ISO 8601) example: '2026-07-15T11:11:49-03:00' release_date: type: string nullable: true description: Data em que o valor será liberado para saque (quando aplicável) example: '2026-08-04' order_hash: type: string nullable: true description: Hash do pedido relacionado (quando aplicável) example: TOCA3F111503K9Z42QM transaction_hash: type: string nullable: true description: Hash da transação relacionada (quando aplicável) example: TPPB2A10307L7R14EUE product_hash: type: string nullable: true description: Hash do produto relacionado (quando aplicável) example: PRDA1B2C3 product_name: type: string nullable: true description: Nome do produto relacionado (quando aplicável) example: Curso Exemplo entry_type: type: string description: | Código estável do tipo de movimentação. Valores atuais: `MONEY_ADDED` (comissão), `MONEY_SUBTRACTED` (reembolso/subtração), `MONEY_BLOCKED`, `MONEY_UNBLOCKED`, `MONEY_RELEASED`, `CASHOUT`, `CASHOUT_CANCELLED`, `ANTICIPATION`, `DISPUTE_RESTORED`, `CHARGEBACK_FEE`, `REFUND_FEE`, `BALANCE_ADJUSTMENT`, `SERVICE_CHARGE_FEE`, `STATEMENT_AUDIT`. Novos tipos podem ser adicionados; trate valores desconhecidos de forma tolerante. example: MONEY_ADDED description: type: string description: > Descrição do lançamento como exibida no painel (ex.: "Comissão de Produtor", "Reembolso", "Saque", "Comissão de Produtor (Parcela 2/12)"). Localizada pelo header `Accept-Language`. example: Comissão de Produtor operation: type: string description: | Natureza da movimentação sobre o saldo total: `credit` (entrada), `debit` (saída) ou `neutral` (não altera o saldo total, ex.: liberação de saldo pendente para disponível). enum: - credit - debit - neutral example: credit amount: type: integer description: | Valor da movimentação em centavos (sempre positivo; use `operation` para o sinal). **Atenção — a base do valor muda conforme o tipo de lançamento.** Em comissões (`MONEY_ADDED`) de vendas parceladas, `amount` traz o **valor total da venda**, e não o da parcela — a parcela aparece no sufixo da `description` ("Parcela 2/12") e é ela que afeta o `balance`. Já em reembolsos (`MONEY_SUBTRACTED`) e nos demais lançamentos, `amount` traz o **valor daquela parcela**. Consequência prática: para uma mesma venda parcelada, a linha de comissão e a linha de reembolso exibem valores diferentes (ex.: comissão 45000 e reembolso 15000 na parcela 1/3). **Não some `amount` para reconciliar saldo** — use `balance`, que reflete o saldo real após cada movimentação. example: 15714 balance: type: integer description: Saldo total (disponível + pendente) em centavos após a movimentação example: 231306 AccountStatementPagination: type: object description: Metadados de paginação do extrato properties: current_page: type: integer nullable: true example: 1 from: type: integer nullable: true example: 1 per_page: type: integer nullable: true example: 15 to: type: integer nullable: true example: 15 total: type: integer nullable: true example: 87 securitySchemes: ApiClientToken: type: apiKey in: header name: X-Api-Client-Token description: Token de autenticação do cliente obtido via endpoint /auth bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Token de autenticação do usuário (public_token) obtido na criação do usuário ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.