| 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. |
Request Body
{
"liquidacoes": [
{
"numeroControleParticipante": "0001",
"numeroDocumento": "12345",
"dataLiquidacao": "2024-11-15T18:25:43.511Z",
"valorPago": 1000
}
]
}
Response Body — 200 OK
{
"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.
Response Body — 400 Bad Request (título em carteira do cedente)
{
"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.
Response Body — 400 Bad Request (nenhum título localizado)
{
"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. |