Bem-vindo à documentação da API Fintely — sua plataforma completa para gestão de assinaturas, cobranças e faturamento.
A API Fintely permite que você automatize todo o ciclo de vida de assinaturas: desde o cadastro de serviços e planos, passando pela criação de assinaturas e geração de faturas, até o processamento de pagamentos via múltiplos gateways (PIX, Boleto, Cartão de crédito).
Visão Geral
A API é RESTful e utiliza URLs previsíveis orientadas a recursos. Todas as requisições e respostas utilizam o formato JSON. Valores monetários são retornados em reais (BRL) no formato decimal.
Recursos Principais
- Pessoas — Cadastro de beneficiários e representantes financeiros
- Serviços — Gerenciamento do catálogo de serviços
- Planos — Criação de planos de assinatura com recorrências flexíveis (mensal, semestral, anual, avulso)
- Assinaturas — Gestão completa do ciclo de vida de assinaturas
- Grupos de Assinatura — Configuração de checkout com múltiplos planos e formas de pagamento
- Links Personalizados — Links de assinatura com dados pré-preenchidos
- Faturas — Consulta de faturas, pagamentos e notas fiscais (NFS-e)
- Configuração — Consulta e atualização das configurações da conta
Ambientes
| Ambiente | URL Base |
|---|---|
| Produção | https://api.fintely.com.br/v1 |
| Desenvolvimento | http://localhost:3007/v1 |
Próximos Passos
Consulte a seção de Autenticação para começar a integrar com a API.
Last modified on