| Método | URL |
|---|---|
https://BASE_URL/public/v1/recebiveis/lotes/liquidacao |
Cria um lote de liquidação para receber informações de pagamento, repasse, liquidação ou recompra.
Request Body
{
"idOperacao": 12345,
"idOcorrencia": 2,
"cedente": {
"tipoPessoa": 2,
"cpfCnpj": "12345678000195"
},
"idDeposito": "123456"
}
Response Body — 200 OK
{
"id": 987,
"idLote": 987,
"idOcorrencia": 2,
"ocorrencia": "Repasse",
"idEmpresa": 4,
"empresa": "Empresa Exemplo LTDA",
"percentualDesagio": 0,
"valorNominalTotal": 0,
"valorAquisicaoTotal": 0,
"valorDescontoTotal": 0,
"valorPagoTotal": 0,
"quantidadeTitulos": 0,
"quantidadeLiquidacoes": 0,
"idStatus": 1,
"status": "Em Digitação",
"erros": [],
"reenvioArquivoFundoDisponivel": false
}
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. Ver Ocorrências. |
cedente | Cedente | Dados do cedente da operação. |
percentualDesagio | Decimal | Percentual de deságio. Campo opcional. |
idDeposito | Texto | Identificador do depósito ou pagamento realizado ao fundo. Campo opcional. |
formaLiquidacaoSacado | Número | Forma da liquidação pelo sacado: 1 = Boleto, 2 = Depósito. Campo opcional. Só é considerado na ocorrência 6 (Liquidação Sacado) em operação cujo fundo é administrado pelo Banco Daycoval; nos demais casos, é ignorado e o lote é criado sem forma 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. |
Ocorrências¶
| Id | Ocorrência | Descrição |
|---|---|---|
2 | Repasse | Informa liquidações ao FIDC para conciliação com valores pagos em conta. |
3 | Recompra com adiantamento | Informa recompras com adiantamento. |
4 | Resolução | Informa resolução de ativos. |
5 | Liquidação Cedente | Informa liquidação realizada pelo cedente. |
6 | Liquidação Sacado | Informa liquidação realizada pelo sacado. |
7 | Recompra com substituição | Informa recompras com substituição. |
Retorno¶
O retorno segue o modelo de detalhes do lote descrito em Consultar Lote.
Repasse que aguarda o depósito¶
Quando a operação tem a etapa Aguardar depósito habilitada, o lote de Repasse (idOcorrencia 2) criado por esta rota já sai de Em Digitação e nasce no status Aguardando Depósito (idStatus 28):
Response Body — 200 OK (repasse aguardando depósito)
{
"id": 988,
"idLote": 988,
"idOcorrencia": 2,
"ocorrencia": "Repasse",
"idStatus": 28,
"status": "Aguardando Depósito",
"erros": [],
"reenvioArquivoFundoDisponivel": false
}
Nesse status:
- as liquidações são adicionadas normalmente com Adicionar Liquidações;
- não chame Enviar Lote: o envio só é aceito em Em Digitação e é recusado aqui;
- o lote avança sozinho para o processamento quando o depósito é conciliado — é preciso que o lote tenha ao menos um título e que o identificador do depósito esteja no lote (
idDeposito) ou em todos os seus títulos.
Sem a etapa habilitada na operação, o repasse nasce em Em Digitação e segue o fluxo normal, com envio por Enviar Lote.
Exemplo resumido
O retorno acima foi abreviado; na resposta real vêm todos os campos de Consultar Lote.
Respostas de erro¶
Erros de negócio retornam 400 Bad Request com o envelope RetornoPadrao ({ "status": "erro", "mensagem": "..." }). Nenhum lote é criado.
| Cenário | Mensagem |
|---|---|
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. |
Operação informada (idOperacao) não existe. | Operação com ID {idOperacao} não encontrada. |