Ir para o conteúdo

8.1. Cadastrar Cedente Simplificado

Cadastro enxuto de um estabelecimento comercial já vinculado a uma operação de cartões, para uso no fluxo de antecipação automática.

Este endpoint é um atalho: faz, numa só chamada, o que hoje exige criar o cedente e depois vinculá-lo à operação. Ele existe porque, para antecipar recebíveis de cartão, o conjunto de dados necessário é bem menor do que o de uma cessão de duplicatas: basta identificar o estabelecimento e a operação em que ele vai operar.

Use o cadastro completo quando precisar de mais do que cartões

Sócios, representantes, avalistas, documentos, contas correntes e contatos não são tratados aqui. Se o cedente também vai ceder duplicatas, ou se o fundo exige ficha cadastral completa, use os endpoints das seções 2 a 5 — este atalho não os substitui.

É idempotente

Se o documento já estiver cadastrado no grupo econômico, nenhum cedente novo é criado: o existente é devolvido e apenas o vínculo com a operação é garantido. A resposta indica isso em jaExistia. Reexecutar a mesma chamada é seguro.


Cadastrar Cedente Simplificado

Método URL
POST https://BASE_URL/public/api/v1/cedentes/simplificado

Cria o cedente com o mínimo necessário e o vincula à operação informada.

Request Body

Campo Tipo Obrigatório Descrição
documento Texto Sim CNPJ (14 dígitos) ou CPF (11 dígitos) do estabelecimento, com ou sem máscara — até 18 caracteres. A máscara é removida antes da validação, e o tamanho define o tipo de pessoa.
razaoSocial Texto Sim Razão social do estabelecimento. Máximo de 200 caracteres.
idOperacao Número Sim Identificador da operação de antecipação de cartões à qual o cedente será vinculado.
nome Texto Não Nome fantasia. Quando omitido, assume o valor de razaoSocial.
email Texto Não E-mail corporativo do estabelecimento.
responsavelOptIn Objeto Não Dados do responsável pelo OPT-IN. Ver Responsável pelo OPT-IN.

Responsável pelo OPT-IN

Campo Tipo Obrigatório Descrição
nome Texto Não Nome do responsável pela autorização.
email Texto Não E-mail do responsável pela autorização.

Por que o responsável pelo OPT-IN é opcional nesta API

Nas telas da plataforma esses dados existem para que VeHub envie o e-mail de autorização ao estabelecimento. Pela API pública, quem obtém e responde pela autorização é o integrador — não há e-mail a disparar, e por isso os campos deixam de ser exigidos. Informá-los apenas enriquece o cadastro e facilita o atendimento posterior.

Request Body — mínimo
{
  "documento": "12345678000195",
  "razaoSocial": "LOJA EXEMPLO COMERCIO LTDA",
  "idOperacao": 1
}
Request Body — completo
{
  "documento": "12345678000195",
  "razaoSocial": "LOJA EXEMPLO COMERCIO LTDA",
  "idOperacao": 1,
  "nome": "LOJA EXEMPLO",
  "email": "financeiro@exemplo.com.br",
  "responsavelOptIn": {
    "nome": "Maria Souza",
    "email": "maria@exemplo.com.br"
  }
}
Response Body — 201 Created
{
  "idEmpresa": 4821,
  "documento": "12345678000195",
  "nome": "LOJA EXEMPLO",
  "idOperacao": 1,
  "idVinculo": 9133,
  "jaExistia": false
}

Detalhamento da resposta

Campo Tipo Descrição
idEmpresa Número Identificador do cedente. Use-o nos demais endpoints desta seção.
documento Texto Documento normalizado, somente números.
nome Texto Nome fantasia gravado.
idOperacao Número Operação à qual o cedente foi vinculado.
idVinculo Número Identificador do vínculo cedente × operação.
jaExistia Booleano true quando o cedente já estava cadastrado e a chamada apenas garantiu o vínculo.

Erros

Status Quando acontece Mensagem
400 Payload inválido — documento malformado ou com dígito verificador inválido, razão social ausente, etc. Ex.: O CNPJ '12.345.678/0001-90' é inválido., O documento '123' deve ter 11 dígitos (CPF) ou 14 dígitos (CNPJ).
401 Token ausente, expirado ou sem permissão de acesso à API pública. —
403 Grupo econômico não habilitado para antecipação automática. Grupo econômico não habilitado para antecipação automática.
404 Operação não encontrada no grupo econômico. Operação não encontrada no grupo econômico.
422 Operação que não é de antecipação de cartões, ou que está inativa. A operação não é de antecipação de cartões. / A operação está inativa.

O 400 vem no formato ProblemDetails, com as mensagens em errors. No 403, 404 e 422, o corpo traz apenas a mensagem, como string JSON:

Response Body — 422 Unprocessable Entity
"A operação não é de antecipação de cartões."

Próximo passo

Com o cedente criado e vinculado, habilite o ciclo automático em 8.2. Habilitar Antecipação Automática.