Ir para o conteúdo
Método URL
POST https://BASE_URL/public/v1/recebiveis/lotes/cessao

Cria um lote de cessão para receber títulos.

Request Body
{
  "idOperacao": 12345,
  "idOcorrencia": 1,
  "cedente": {
    "tipoPessoa": 2,
    "cpfCnpj": "12345678000199"
  },
  "percentualDesagio": 2.5
}
Response Body — 200 OK
{
  "id": 987,
  "idLote": 987,
  "idOcorrencia": 1,
  "ocorrencia": "Cessão",
  "idEmpresa": 4,
  "empresa": "Empresa Exemplo LTDA",
  "percentualDesagio": 2.5,
  "valorNominalTotal": 0,
  "valorAquisicaoTotal": 0,
  "valorDescontoTotal": 0,
  "valorPagoTotal": 0,
  "quantidadeTitulos": 0,
  "quantidadeLiquidacoes": 0,
  "idStatus": 1,
  "status": "Em Digitação",
  "erros": []
}

Modelo de dados

Requisição

Campo Tipo Descrição
idOperacao Número Identificador da operação fornecido pela Vertrau.
idOcorrencia Número Código da ocorrência do lote. Para cessão, utilize 1.
cedente Cedente Dados do cedente da operação.
percentualDesagio Decimal Percentual de deságio aplicado à operação. Campo opcional.
idDeposito Texto Identificador de depósito. Campo opcional exposto no contrato, normalmente utilizado em fluxos de liquidação.

Cedente

Campo Tipo Descrição
tipoPessoa Número 1 = Pessoa Física, 2 = Pessoa Jurídica.
cpfCnpj Texto Documento do cedente, somente números.

Retorno

Campo Tipo Descrição
id Número Identificador do lote.
idLote Número Identificador do lote gerado.
idOcorrencia Número Código da ocorrência do lote.
ocorrencia Texto Descrição da ocorrência.
idEmpresa Número Identificador da empresa cedente.
empresa Texto Nome da empresa cedente.
percentualDesagio Decimal Percentual de deságio aplicado.
valorNominalTotal Decimal Valor nominal total dos títulos do lote.
valorAquisicaoTotal Decimal Valor total de aquisição dos títulos do lote.
valorDescontoTotal Decimal Valor total de desconto do lote.
valorPagoTotal Decimal Valor total pago no lote.
quantidadeTitulos Número Quantidade de títulos no lote.
quantidadeLiquidacoes Número Quantidade de liquidações no lote.
idStatus Número Código do status atual do lote.
status Texto Descrição do status atual do lote.
erros Lista de texto Erros associados ao lote, quando houver.

Respostas de erro

Erros de negócio retornam 400 Bad Request com o envelope RetornoPadrao no formato { "status": "erro", "mensagem": "..." }.

Response Body — 400 Bad Request
{
  "status": "erro",
  "mensagem": "Operação com ID 12345 não encontrada."
}
Cenário Mensagem
Operação informada (idOperacao) não existe. Operação com ID {idOperacao} não encontrada.
Cedente (resolvido pelo cpfCnpj) não existe. Empresa com o CNPJ {cnpj} não encontrada.
Cedente (resolvido pelo cpfCnpj) está inativo. Cedente {cpfCnpj} está inativo e não pode receber novos títulos.

Atenção: as validações de cedente e operação ocorrem antes de qualquer gravação — nenhum lote é criado quando uma delas falha. Confirme que o idOperacao é o identificador fornecido pela Vertrau e que o cpfCnpj do cedente corresponde a uma empresa cadastrada e ativa.

Atenção: se o cedente informado (resolvido pelo cpfCnpj) estiver inativo, a criação do lote é rejeitada com 400 Bad Request e a mensagem Cedente {cpfCnpj} está inativo e não pode receber novos títulos., antes de qualquer gravação. Lotes e títulos já em andamento não são afetados; basta reativar o cedente para voltar a criar novos lotes.