Guides
  1. referencia-tecnica

Lista de endpoints

1. Autenticação

MétodoCaminhoDescriçãoDetalhes
POST/tokenTrocar credenciais por Bearer JWTAutenticação

2. Cessão

MétodoCaminhoDescriçãoDetalhes
POST/loanCeder operação com lastro (agnóstico ao tipo)Cessão de operações
POST/loan/filesAnexar lastro a operação já criadaCessão
GET/loan/{originator_proposal_code}Consultar status e histórico de uma operaçãoCiclo de vida
GET/loanListar operações com filtros (status, fundo, período)Cessão

3. Liquidação

MétodoCaminhoDescriçãoDetalhes
POST/installment/settleNotificar liquidação de parcela (na curva, com atraso, a menor)Liquidação
POST/installment/prepaymentNotificar liquidação antecipada (1+ parcelas)Liquidação
GET/installment/{originator_proposal_code}/{installment_code}Consultar status de uma parcela específicaLiquidação

4. Pós-cessão

MétodoCaminhoDescriçãoDetalhes
POST/loan/repurchaseRecompra, reversão de cessão ou resolução (via campo reason)Pós-cessão
PATCH/loan/renegotiateRenegociar operação — recompra original + nova cessãoPós-cessão

5. Webhooks

MétodoCaminhoDescriçãoDetalhes
POST/webhookRegistrar URL públicaConfigurando webhooks
GET/webhookListar webhooks ativosConfigurando webhooks
PATCH/webhook/{webhook_id}Atualizar URL ou eventos assinadosConfigurando webhooks
POST/webhook/{webhook_id}/pausePausar entrega temporariamenteConfigurando webhooks
POST/webhook/{webhook_id}/resumeRetomar entregaConfigurando webhooks
POST/webhook/{webhook_id}/rotate-secretGerar novo signing_secretSegurança
DELETE/webhook/{webhook_id}Remover webhookConfigurando webhooks
GET/webhook/{webhook_id}/deliveriesHistórico de entregas (sucesso e falha)Idempotência
POST/webhook/event/{event_id}/redeliverForçar reentrega de um evento específicoIdempotência

6. Fundos e parceiros

MétodoCaminhoDescriçãoDetalhes
GET/fundsListar fundos provisionados para a aplicação—
GET/funds/{fund_id}Detalhes do fundo (tipo, ADM, configuração)—
GET/funds/{fund_id}/eligibilityCritérios de elegibilidade configuradosElegibilidade
GET/partners/meIdentidade do parceiro vinculado ao tokenAtores

7. Próximos passos

Continuar — Schemas

Estruturas reutilizáveis dos payloads.

Download — OpenAPI

Spec completa para tooling automático.

Updated about 6 hours ago