Skip to main content
Consultar indicação

Authorizations

Authorization
string
header
required

Chave de API do parceiro, entregue pelo time de integrações da Wincred. Header: Authorization: Bearer <chave do parceiro> (o esquema Bearer não diferencia maiúsculas). Por segurança, chave ausente, malformada, inválida ou revogada recebem a mesma resposta: 401 UNAUTHENTICATED. Guarde a chave apenas no servidor e solicite a rotação ao time de integrações quando precisar trocá-la.

Headers

X-Request-Id
string

Identificador da requisição, até 64 caracteres [A-Za-z0-9_-]. Se faltar ou for inválido, a Wincred gera um. Volta no header X-Request-Id da resposta e no request_id de todo erro.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Path Parameters

process_external_id
string<uuid>
required

Identificador do processo, devolvido em POST /referrals e em todo webhook.

Response

Visão atual do processo.

Visão do processo. Mesma estrutura no GET e no data do webhook. Campos que o processo ainda não tem são omitidos da resposta.

process_external_id
string<uuid>
required
hub_code
string
required
status
enum<string>
required

Último marco alcançado. Pode voltar: depois de um reset, o processo retorna a term_signed, porque o contrato anterior foi encerrado antes do desembolso e o cliente escolhe uma nova proposta. Prepare a sua máquina de estados para esse retorno.

Available options:
awaiting_client,
term_signed,
contract_created,
loan_disbursed,
closed
proposal
object

Proposta selecionada pelo cliente; ausente enquanto não há seleção. O valor é o da proposta, e não o pedido do parceiro: o cliente pode tê-lo ajustado na jornada.

ccb_number
string

Número da CCB. Presente a partir da criação do contrato.

Example:

"1234"

disbursed_at
string<date-time>

Data e hora do desembolso. Presente a partir do desembolso.