Ir para o conteúdo

4.6. Vincular Financiador

Gerencia o vínculo entre emitentes e financiadores. Um emitente pode ser vinculado a múltiplos financiadores, com limite de crédito individual por vínculo.

Listar Financiadores Vinculados

🔗 Endpoint

Método URL
GET /public/v1/emitentes/{id}/financiadores

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único do emitente

🧪 Exemplo de cURL

curl -X GET https://api.vehub.com.br/public/v1/emitentes/42/financiadores \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "registros": [
    {
      "id": 1,
      "idFinanciador": 3,
      "nomeFinanciador": "Financiadora Alpha S.A.",
      "limiteCredito": 5000000.00
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 1,
    "paginaQuantidadeRegistro": 10,
    "quantidadeRegistros": 1,
    "temProximaPagina": false,
    "temPaginaAnterior": false
  }
}

Detalhamento dos Campos — registros[]

Campo Tipo Descrição
id integer Identificador único do vínculo
idFinanciador integer ID do financiador
nomeFinanciador string Nome do financiador
limiteCredito number Limite de crédito aprovado para este emitente (0.00 se ilimitado)

Criar Vínculo

🔗 Endpoint

Método URL
POST /public/v1/emitentes/{id}/financiadores

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único do emitente

📋 Payload (JSON)

{
  "idFinanciador": 3,
  "limiteCredito": 5000000.00
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
idFinanciador integer Sim ID do financiador (ver 3.1. Financiadores)
limiteCredito number Não Limite de crédito para este emitente. Omitir para ilimitado

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/v1/emitentes/42/financiadores \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "idFinanciador": 3,
    "limiteCredito": 5000000.00
  }'

📥 Response — 201 Created

{
  "mensagem": "Financiador vinculado com sucesso.",
  "id": 1
}

Atualizar Vínculo

🔗 Endpoint

Método URL
PATCH /public/v1/emitentes/{id}/financiadores/{idVinculo}

🔹 Path Parameters

Parâmetro Tipo Descrição
id integer Identificador único do emitente
idVinculo integer Identificador único do vínculo

📋 Payload (JSON)

{
  "limiteCredito": 8000000.00
}

O campo idFinanciador não pode ser alterado após a criação do vínculo.

📥 Response — 200 OK

{
  "mensagem": "Vínculo atualizado com sucesso."
}

Remover Vínculo

🔗 Endpoint

Método URL
DELETE /public/v1/emitentes/{id}/financiadores/{idVinculo}

📥 Response — 200 OK

{
  "mensagem": "Vínculo removido com sucesso."
}

❌ Erros Comuns

400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": ["Campo 'idFinanciador' é obrigatório."]
}

409 Conflict

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.10",
  "titulo": "Conflito",
  "status": 409,
  "erros": ["Este emitente já está vinculado ao financiador informado."]
}