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 |
|---|---|
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 ou CPF do estabelecimento, somente números, sem formatação. |
razaoSocial | Texto | Sim | Razão social do estabelecimento. Máximo de 200 caracteres. |
idOperacao | Número | Sim | Identificador da operaçã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.
{
"documento": "12345678000199",
"razaoSocial": "LOJA EXEMPLO COMERCIO LTDA",
"idOperacao": 1
}
{
"documento": "12345678000199",
"razaoSocial": "LOJA EXEMPLO COMERCIO LTDA",
"idOperacao": 1,
"nome": "LOJA EXEMPLO",
"email": "financeiro@exemplo.com.br",
"responsavelOptIn": {
"nome": "Maria Souza",
"email": "maria@exemplo.com.br"
}
}
{
"idEmpresa": 4821,
"documento": "12345678000199",
"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 |
|---|---|
400 | Payload inválido — documento malformado, razão social ausente, etc. |
401 | Token ausente, expirado ou sem permissão de acesso à API pública. |
404 | Operação não encontrada no grupo econômico. |
422 | Operação não é de cartões, ou está inativa. |
Próximo passo¶
Com o cedente criado e vinculado, habilite o ciclo automático em 8.2. Habilitar Antecipação Automática.