Skip to main content
Com a API do Parceiro, você indica clientes para o crédito consignado CLT da Wincred e acompanha a evolução da proposta de forma reativa. O parceiro não conduz a jornada: simulação, envio de propostas e formalização/assinatura são realizados diretamente pelo cliente no link seguro disponibilizado pela Wincred. Na prática, o seu sistema atua como um ouvinte: basta registrar o cliente e implementar um endpoint (webhook) para receber notificações em tempo real a cada mudança de status no sistema da Wincred.

As 4 rotas

A API tem quatro rotas na base /partners/v1, todas autenticadas por chave de API: Para mantê-lo atualizado, a Wincred envia requisições POST para a URL configurada no seu cadastro a cada mudança de status da indicação. Para saber mais sobre os payloads e eventos, consulte Webhooks.
A documentação técnica detalhada de cada rota, com schemas, parâmetros, exemplos de requisição e códigos de erro, está disponível em Referência da API, no menu lateral.Já este guia foca nas regras de negócio, no fluxo de integração e nas boas práticas que você precisa conhecer para operar com a Wincred.

Por onde seguir

Início rápido

Da chave de dev à primeira indicação, em quatro comandos.

Como integrar

O onboarding com o time de integrações e o caminho até a produção.

Ciclo de vida

Os status da indicação e as 5 regras para uma integração previsível.

Webhooks

Formato, assinatura, retentativas e deduplicação.