> ## 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 > Retorna o extrato financeiro paginado do usuário autenticado, contendo o saldo consolidado (no mesmo formato de `/financial/balance`), a lista de eventos financeiros (vendas, reembolsos, antecipações, saques, etc.) e os metadados de paginação. O resultado é cacheado por 10 minutos por usuário/conta/filtros. ## OpenAPI ````yaml /api-reference/openapi.yaml get /financial/account-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/account-statement: get: tags: - Financeiro summary: Consultar extrato financeiro description: > Retorna o extrato financeiro paginado do usuário autenticado, contendo o saldo consolidado (no mesmo formato de `/financial/balance`), a lista de eventos financeiros (vendas, reembolsos, antecipações, saques, etc.) e os metadados de paginação. O resultado é cacheado por 10 minutos por usuário/conta/filtros. operationId: getAccountStatement 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 os eventos do extrato 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/01/2026,31/01/2026 responses: '200': description: Extrato retornado com sucesso content: application/json: schema: $ref: '#/components/schemas/ResponseAccountStatement' '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: ResponseAccountStatement: type: object required: - status - message - data properties: status: type: string example: success message: type: string example: Recurso retornado com sucesso data: type: object required: - balance - statements - pagination properties: balance: $ref: '#/components/schemas/ResponseBalance' statements: type: array items: $ref: '#/components/schemas/AccountStatementItem' pagination: $ref: '#/components/schemas/AccountStatementPagination' ResponseBalance: type: object properties: available: type: integer description: Saldo disponível em centavos under_review: type: integer description: Saldo em análise (bloqueado pelo Compliance) em centavos pending: type: integer description: Saldo pendente de liberação em centavos anticipation: type: integer description: Saldo de antecipação em centavos can_anticipate: type: boolean description: Se o usuário pode solicitar antecipação AccountStatementItem: type: object description: Evento individual do extrato financeiro properties: transaction_date: type: string nullable: true description: Data em que o evento ocorreu example: '2026-02-15T14:32:10.000000Z' order_hash: type: string nullable: true description: Hash do pedido relacionado ao evento (quando aplicável) example: TOCA3F111503K9Z42QM available_at: type: string nullable: true description: Data em que o valor ficará disponível para saque example: '2026-03-17T00:00:00.000000Z' transaction_hash: type: string nullable: true description: Hash da transação relacionada ao evento (quando aplicável) example: TRX9KX2HQR product_hash: type: string nullable: true description: Hash do produto relacionado ao evento (quando aplicável) example: PRDA1B2C3 product_id: type: integer nullable: true description: ID interno do produto relacionado ao evento (quando aplicável) example: 1234 event_type: type: string description: >- Tipo do evento financeiro (ex.: SALE, REFUND, ANTICIPATION, CASHOUT, CHARGEBACK) example: SALE default: UNKNOWN amount: type: integer description: >- Valor do evento em centavos (positivo para entradas, negativo para saídas) example: 9750 available_balance: type: integer description: Saldo disponível em centavos após o evento example: 50000 pending_balance: type: integer description: Saldo pendente em centavos após o evento example: 12500 current_balance: type: integer description: Saldo total (disponível + pendente) em centavos após o evento example: 62500 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.