Ir para o conteúdo

3.3. Parceiros

Especificação — em construção

Os serviços descritos nesta área ainda não estão disponíveis.

Somente CDC

Estes serviços só fazem sentido em esteiras de CDC com destinatarioDesembolso = 2 (Parceiro). Em EP o desembolso vai sempre para a conta do tomador e o conceito de parceiro originador não se aplica.

Listar parceiros da esteira

🔗 Endpoint

Método URL
GET /credito/esteiras/{idEsteira}/parceiros

🧾 Descrição

Lista os parceiros originadores (lojistas) disponíveis para a esteira. É a origem do idParceiroOriginador informado em 6.3. Desembolso ao Parceiro.

🧪 Exemplo de cURL

curl -X GET "https://api.vehub.com.br/credito/esteiras/18/parceiros" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "registros": [
    { "id": 42, "nome": "Loja Centro LTDA", "documento": "12345678000199", "ativo": true },
    { "id": 57, "nome": "Loja Norte ME", "documento": "98765432000155", "ativo": true }
  ],
  "paginacao": { "pagina": 1, "quantidade": 50, "total": 2 },
  "mensagem": null
}
Campo Tipo Descrição
id integer Identificador do parceiro
nome string Razão social
documento string CNPJ, sem máscara
ativo boolean Parceiro inativo não pode receber desembolso

Consultar dados de desembolso do parceiro

🔗 Endpoint

Método URL
GET /credito/parceiros/{idParceiro}/desembolso

🧾 Descrição

Devolve o nome, o documento e a conta bancária para a qual o valor da operação será liberado. Use-o para exibir ao operador a conta de destino antes de confirmar a proposta.

🧪 Exemplo de cURL

curl -X GET "https://api.vehub.com.br/credito/parceiros/42/desembolso" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "id": 42,
  "nome": "Loja Centro LTDA",
  "documento": "12345678000199",
  "conta": {
    "idBanco": 1,
    "agencia": "12345",
    "conta": "9876543",
    "tipo": 2,
    "completa": true
  }
}
Campo Tipo Descrição
conta.idBanco integer Código do banco — ver GET /enumeracoes/bancos
conta.agencia string Agência. O dígito verificador é o último caractere quando há 5 dígitos
conta.conta string Conta. O último caractere é o dígito verificador
conta.tipo integer 1 Poupança, 2 Corrente
conta.completa boolean false quando falta banco, agência, conta ou tipo

⚠️ Parceiro sem conta completa bloqueia a operação

Se conta.completa for false, a proposta não pode ser enviada — a plataforma recusa antes de chamar a bancarizadora. O cadastro bancário do parceiro precisa ser completado na plataforma, em Cadastros › Parceiros; não há como informá-lo por esta API.

Verifique completa no momento em que o operador seleciona o parceiro, e não no envio da proposta. Descobrir o problema no fim da jornada custa o retrabalho da ficha inteira.

⚠️ Um "parceiro", um significado

A plataforma tem um segundo conceito chamado "parceiro correspondente", configurado na esteira e usado na comunicação com a bancarizadora. Ele não é obrigatório em EP e CDC e não é exposto nesta API.

Nesta documentação, "parceiro" significa sempre o parceiro originador — o lojista que originou a venda e recebe o desembolso. O campo correspondente na proposta é idParceiroOriginador.