Visão geral
A Quyta é uma plataforma de cobrança e recuperação de crédito. Você envia a sua carteira de títulos vencidos, a Quyta executa a régua de cobrança — mensagens, negociação e pagamento — e devolve para o seu sistema o que aconteceu com cada dívida.
A API pública existe para os dois lados dessa troca:
| Direção | Mecanismo | Serve para |
|---|---|---|
| Seu sistema → Quyta | API REST | Cadastrar devedores, enviar dívidas e mantê-las atualizadas. |
| Quyta → seu sistema | Webhooks | Saber, em tempo real, que um acordo foi fechado, uma parcela foi paga ou uma dívida mudou de estado. |
Quem só empurra carteira usa a API REST. Quem precisa dar baixa no ERP quando o dinheiro entra precisa dos dois.
O fluxo em uma frase
Você cria o cliente, cria a dívida dele dentro de um grupo de dívidas, e a partir daí a Quyta assume: cobra, negocia, fecha o acordo e recebe as parcelas — avisando seu sistema por webhook a cada passo.
O que a API faz — e o que ela não faz
Faz:
- cadastro e atualização de clientes, com telefones e e-mails;
- criação e atualização de dívidas;
- consulta de dívidas, clientes e grupos de dívidas;
- notificação de eventos de cobrança por webhook.
Não faz — isso acontece dentro do painel da Quyta, não pela API:
- criar grupos de dívidas (a API só os lê);
- montar ou alterar a régua de cobrança;
- negociar ou criar acordos manualmente;
- registrar pagamentos. A baixa vem do meio de pagamento e chega até você por webhook.
Em outras palavras: a API alimenta a carteira, o painel define a estratégia, os webhooks devolvem o resultado.
Endereço base
Todas as requisições usam HTTPS e partem de:
Code
Por onde seguir
- Conceitos — o modelo de domínio e os estados de cada recurso. Leia antes de escrever código.
- Primeiros passos — uma integração ponta a ponta, do token à primeira dívida.
- Autenticação — tokens e permissões.
- Webhooks — como receber os eventos.
- Referência de API — todos os endpoints, campos e exemplos.