| Método | URL |
|---|---|
https://BASE_URL/public/v1/recebiveis/lotes/{idLote}/liquidacoes |
Adiciona uma ou mais liquidações a um lote existente.
Path Params¶
| Campo | Tipo | Descrição |
|---|---|---|
idLote | Número | Identificador do lote. |
{
"liquidacoes": [
{
"numeroControleParticipante": "0001",
"numeroDocumento": "12345",
"dataLiquidacao": "2024-11-15T18:25:43.511Z",
"valorPago": 1000
}
]
}
{
"status": "sucesso",
"mensagem": "1 registros atualizados com sucesso."
}
Títulos elegíveis¶
Só entra em lote de liquidação o título que já foi cedido ao fundo, ou seja, cujo portador é o Fundo. Título ainda em carteira do cedente não foi adquirido pelo fundo e, portanto, não tem liquidação a ser informada — mesmo que esteja disponível para movimentação.
A validação é all-or-nothing: se qualquer título do payload ainda estiver em carteira do cedente, a requisição inteira é rejeitada e nenhuma liquidação do lote é gravada. A mensagem lista os números de controle recusados, para que você corrija o payload e reenvie.
{
"status": "erro",
"mensagem": "Título(s) ainda em carteira do cedente não podem ser liquidados: 0001, 0002."
}
Use Consultar Título no Estoque para confirmar o portador antes de montar o lote de liquidação.
{
"status": "erro",
"mensagem": "Nenhum titulo encontrado"
}
Modelo de dados¶
Requisição¶
| Campo | Tipo | Descrição |
|---|---|---|
liquidacoes | Lista de Liquidação | Lista de liquidações a serem adicionadas ao lote. |
Liquidação¶
| Campo | Tipo | Descrição |
|---|---|---|
numeroControleParticipante | Texto | Número de controle do participante. |
numeroDocumento | Texto | Número do documento. |
dataLiquidacao | Data/Hora | Data e hora da liquidação. |
valorPago | Decimal | Valor pago na liquidação. |
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
status | Texto | Status do processamento. |
mensagem | Texto | Mensagem retornada pela API. |
Erros¶
Erros retornam HTTP 400 Bad Request com o envelope RetornoPadrao.
| Situação | Mensagem |
|---|---|
| Lote não encontrado | Lote {idLote} não encontrado. |
| Nenhum título encontrado | Nenhum titulo encontrado |
| Título(s) em carteira do cedente | Título(s) ainda em carteira do cedente não podem ser liquidados: {numerosControle}. |
| Título indisponível para movimentação | 1 título não pode entrar no lote: {motivo}. ou {n} de {total} títulos não podem entrar no lote: {motivos}. |
Título indisponível¶
Um numeroControleParticipante que, na operação do lote, só corresponde a títulos indisponíveis para movimentação — já incluídos em outro lote em andamento ou já liquidados — recusa a requisição inteira, e nada é gravado. A mensagem identifica cada título (pelo número do documento) e o motivo, separados por ;. São detalhados até alguns títulos; os demais são resumidos no fim da mensagem.
{
"status": "erro",
"mensagem": "1 título não pode entrar no lote: Título 12345 está no lote #990 (Enviado ao Fundo)."
}
Motivos possíveis para cada título:
| Motivo | Texto na mensagem |
|---|---|
| Ainda em carteira do cedente | não está no estoque do fundo |
| Já liquidado | já foi liquidado em {dd/MM/aaaa} (ou já foi liquidado, sem data) |
| Em outro lote em andamento | está no lote #{idLote} ({status}) |
| Recusado em outro lote ainda não encerrado | foi rejeitado no lote #{idLote} ({status}) |
| Indisponível sem lote em andamento | indisponível para movimentação e sem lote em andamento |
Se houver um título disponível com o mesmo número de controle, é ele que entra no lote, e o título indisponível não impede o pedido.
Somente títulos já cedidos ao fundo (portador = Fundo) podem ser liquidados via este endpoint. Títulos que ainda estão em carteira do cedente (não adquiridos pelo fundo) são rejeitados e a requisição inteira é recusada, listando os numeroControleParticipante recusados na mensagem de erro.