Project Brief - Documentação API Owem
Objetivo
Criar documentação completa e bilíngue (PT-BR e EN) da API Owem para integração de pagamentos PIX e serviços financeiros.Escopo
Documentar todas as APIs da coleção Postman “Owem API Beta” no formato Mintlify.Estrutura de APIs a Documentar
1. Autenticação
- Ping - Validar autenticação e conectividade
2. Ledger (Extrato)
- Consulta de Movimentações
- Consultar Ledger por External ID
- Consultar Ledger por EndToEndId
- Consultar Ledger por entryId (txId)
3. Conta Bancária
- Consultar saldo
4. PIX IN (Recebimentos)
- Gerar QRCODE dinâmico
- Buscar QRCODE por ID
- Estornar PIX IN
- Consultar status do estorno
5. PIX OUT (Pagamentos)
- Transferência externa
- Consultar status da transferência externa
- Pagar QRCODE
6. Webhooks
- Criar webhook
- Atualizar webhook
- Consultar webhook por ID
- Excluir webhook
- Listar todos os webhooks
- Ativar webhook
- Desativar webhook
7. MEDs (Mecanismo Especial de Devolução)
- Consultar MEDs
- Enviar Defesa de Infração (MED)
Base URL
- Produção:
https://api.owem.com.br
Autenticação
- Método: Basic Auth
- Formato:
Authorization: Basic {Base64(API_KEY:API_SECRET)}
Idiomas
- PT-BR (primário)
- EN-US (tradução)