chargeback-docs

📋 Documentação do Sistema de Chargeback

Status Version Documentation

📚 Documentação completa das APIs e notificações do sistema de gerenciamento de chargebacks

🌐 Versões de Idioma

🎯 Visão Geral

Este repositório contém a documentação técnica completa do sistema de chargeback, incluindo especificações de APIs, formatos de notificações e fluxos de dados para integração com sistemas externos.

File Ingestion

📁 Estrutura da Documentação

🔄 1. Enrichment (Enriquecimento de Dados)

Data Enrichment

Nota: A área destacada representa componentes que devem ser desenvolvidos pelo cliente. Isso inclui a implementação da lógica de consulta aos dados internos e o envio das respostas para o nosso sistema durante o fluxo de enriquecimento.

Documentação do fluxo de enriquecimento de dados entre sistema e cliente:

Arquivo Descrição Fluxo de Dados
1.TRANSACTION.md 💳 Dados de Transação
📤 TransactionEvent: Enviado para o cliente
📥 TransactionResponse: Recebido via API		 Event → Cliente
Response ← Cliente
2.MERCHANT.md 🏪 Dados do Estabelecimento Comercial
📤 MerchantEvent: Enviado para o cliente
📥 MerchantResponse: Recebido via API		 Event → Cliente
Response ← Cliente

📢 2. Notifications (Notificações de Sistema)

System Notifications

Documentação das notificações de status e ciclo de vida dos chargebacks:

Arquivo Descrição Tipo de Evento
3.STATUS.md 📊 Notificações de Status - Atualizações de status do processo de chargeback status
4.CYCLE.md 🔄 Notificações de Ciclo - Mudanças de ciclo (chargeback, pré-arbitragem, arbitragem) cycle

🤖 3. AI (Inteligência Artificial)

AI Recommendation

Documentação da integração com agente de IA para recomendações de chargeback:

Arquivo Descrição Tipo de Dados
5.AI.md 🧠 Dados do Agente de IA - Dados de entrada enviados para o agente de IA de recomendação de chargeback API de Entrada

📋 Tipos de Comunicação Disponíveis

🔄 Enriquecimento de Dados (Events ↔ Responses)

Tipo Enviamos (Event) Recebemos (Response) Documentação
transaction Solicita dados de transação Dados completos da transação TRANSACTION.md
merchant Solicita dados do EC Dados completos do estabelecimento MERCHANT.md

📢 Notificações Unidirecionais (Events)

Tipo Enviamos (Event) Propósito Documentação
status Atualização de status Informar mudanças de status STATUS.md
cycle Mudança de ciclo Informar alterações de ciclo CYCLE.md

🔧 Integração

📤📥 Fluxo de Comunicação

O sistema utiliza dois tipos de comunicação:

📤 Events (Eventos) - Enviados pelo Sistema

Notificações que enviamos para o cliente quando precisamos de dados adicionais:

📥 Responses (Respostas) - Recebidas via API

Dados completos que recebemos do cliente via API para atualizar nosso sistema:

Estrutura Base dos Eventos

Todos os eventos enviados seguem uma estrutura base comum:

type BaseEvent = {
    event: string;
    payload: {
        contractDisputeId: string;
        // ... identificadores específicos por tipo de evento
    };
}

Estrutura Base das Respostas

As respostas recebidas via API contêm dados completos:

type BaseResponse = {
    // Dados completos e detalhados do objeto solicitado
    // Estrutura varia conforme o tipo de dados
}

Identificadores Principais

⚙️ Requisitos Mínimos

Para executar o sistema de chargeback, certifique-se de que seu ambiente atenda aos seguintes requisitos mínimos:

🖥️ Requisitos de Hardware

🗄️ Requisitos de Banco de Dados

☸️ Requisitos do Kubernetes

📊 Requisitos de Relatórios e BI

🔒 Requisitos de Segurança

📞 Suporte

Para dúvidas ou sugestões sobre esta documentação, entre em contato com a equipe de desenvolvimento.

**📄 Documentação mantida pela equipe Tupi Fintech** *Última atualização: Fevereiro 2026*