Consultar uma indicação

GET /referrals/{process_external_id} devolve a visão atual do processo, montada no momento da consulta.

curl "$WINCRED_API_URL/referrals/55555555-5555-4555-8555-555555555555" \
  --header "Authorization: Bearer <chave do parceiro>"

Resposta (200), processo com o valor desembolsado:

{
  "process_external_id": "55555555-5555-4555-8555-555555555555",
  "hub_code": "padrao",
  "status": "loan_disbursed",
  "proposal": { "gross_amount": "5000.00", "installments": 24 },
  "ccb_number": "1234",
  "disbursed_at": "2026-09-24T10:12:00-03:00"
}

Resposta (200), link enviado e termo ainda não assinado:

{
  "process_external_id": "55555555-5555-4555-8555-555555555555",
  "hub_code": "padrao",
  "status": "awaiting_client"
}

O GET é a fonte da verdade

A resposta tem a mesma estrutura do data dos webhooks. A diferença é que o data é congelado no momento em que a notificação é gravada, enquanto o GET reflete o estado atual. Por isso, antes de tomar uma decisão no seu sistema, consulte o GET. Consulte também quando:

uma notificação pode ter se perdido, por exemplo depois de uma indisponibilidade do seu endpoint;
um processo ficou parado: o encerramento por termo vencido aparece como closed no GET, mas não gera webhook (veja a regra 3).

Campos que vêm conforme a etapa

proposal, ccb_number e disbursed_at só aparecem quando existem; até lá, são omitidos da resposta em vez de virem como null. A tabela de cada status está em Ciclo de vida.

Erros

HTTP	`code`	Quando
400	`INVALID_REQUEST`	O `process_external_id` não é um UUID
404	`REFERRAL_NOT_FOUND`	Processo inexistente ou pertencente a outro parceiro. Confira o id

Por privacidade, o CPF nunca trafega na URL: a consulta é sempre pelo process_external_id. Referência completa: Consultar indicação.

Introdução

Guia de integração

Referência da API

Eventos

Consultar uma indicação

O GET é a fonte da verdade

Campos que vêm conforme a etapa

Erros