API Conta Simples
Portal de desenvolvedores para integração com a Conta Simples
O que é a API Conta Simples
A API Conta Simples é a interface de integração da Conta Simples. Através dela, parceiros e sistemas externos se conectam à nossa plataforma de forma segura, padronizada e escalável.
Com a API Conta Simples você pode:
- Consultar e criar categorias da empresa — listar categorias com estabelecimentos vinculados e tipo, ou criar categoria personalizada com nome único por empresa
- Consultar categorias da empresa — listar categorias com estabelecimentos vinculados e tipo, ou obter uma categoria pelo ID
- Consultar extrato bancário — listar transações bancárias da empresa com filtros por período, conta, categoria, centro de custo, status e valor
- Consultar transações de cartão de crédito e conciliar com seus sistemas
- Gerenciar cartões corporativos — listar, bloquear e desbloquear cartões físicos e virtuais
- Consultar usuários da empresa — listar usuários com filtro por e-mail e paginação
- Consultar convites de usuários — listar convites pendentes, expirados ou excluídos com filtros por status e papel
- Convidar usuários para a empresa — enviar convites por e-mail com papel (role) definido
- Consultar papéis (roles) da empresa — listar papéis com permissões, perfil e quantidade de usuários vinculados
- Excluir usuários da empresa — remover usuários pelo ID
- Baixar comprovantes e documentos anexados às transações
- Automatizar fluxos financeiros do seu negócio
Para quem é
Empresas e Parceiros
Empresas que precisam emitir cartões corporativos ou integrar fluxos financeiros.
Desenvolvedores
Times técnicos responsáveis por construir integrações com a Conta Simples.
Fintechs e Plataformas
Plataformas que integram pagamentos, cartões e gestão financeira.
Operações e Compliance
Equipes que precisam garantir conformidade e monitoramento.
Por onde começar
Siga esta jornada recomendada para integrar com a API Conta Simples:
Quickstart — sua primeira chamada
Configure credenciais, obtenha um token e faça sua primeira consulta de transações em 5 minutos.
Entenda o fluxo completo
Leia o fluxo de integração recomendado com o passo a passo de cada etapa, do Sandbox à Produção.
Aplique as boas práticas
Padrões de paginação, retry e tratamento de erros para uma integração robusta.
Consulte a API Reference
Use a referência técnica dos endpoints para detalhes de parâmetros, schemas e exemplos.
Princípios da API
Seguimos convenções REST padrão. Recursos são substantivos, verbos HTTP indicam ações, e respostas seguem estruturas consistentes.
Autenticação via tokens, comunicação exclusiva por HTTPS.
A API é versionada para garantir estabilidade. Mudanças breaking são comunicadas com antecedência e documentadas no changelog.
Acesso rápido
Quickstart
Configure e faça sua primeira chamada em 5 min.
Autenticação
OAuth 2.0 Client Credentials (api_key + api_secret via Basic) e renovação de token.
Fluxo de Integração
Passo a passo do Sandbox à Produção.
Boas Práticas
Paginação, retry e tratamento de erros.
API Reference
Referência técnica dos endpoints.
Dicionário de Dados
Entidades, campos e enumerações.
Dúvidas? Consulte o guia de suporte para saber como entrar em contato com o time técnico.
Last updated today
Built with Documentation.AI