Recebíveis Apropriados
Notificação enviada quando recebíveis antecipados são apropriados para quitar a antecipação.
Notifica o cliente sempre que recebíveis antecipados são apropriados, ou seja, quando a liquidação do recebível é efetivada e o valor é apropriado para quitar a antecipação.
As notificações são agrupadas por movimento financeiro. Em vez de um webhook por recebível, cada notificação traz a lista de recebíveis apropriados de um mesmo movimento. Um movimento pode ser entregue em mais de um webhook (veja "Agrupamento e divisão").
Configuração
Para receber o webhook, cadastre a URL de destino no parâmetro do cliente UrlNotificacaoAntecipacaoApropriada.
- A URL deve ser válida e acessível publicamente (HTTPS recomendado).
- Clientes sem o parâmetro preenchido não recebem a notificação.
Quando é enviado
- O envio acontece logo após identificarmos a apropriação. Ela é informada pela instituição financeira, e a notificação costuma ser enviada em até alguns minutos.
- São notificadas as apropriações do dia atual e do dia anterior.
- Valem recebíveis de transações e de cobranças.
- Cada recebível é notificado uma única vez.
Agrupamento e divisão
- Os recebíveis são agrupados por convênio + número do movimento financeiro da apropriação.
- Quando o número do movimento ainda não foi informado, o agrupamento é feito por antecipação + data da apropriação, e
NumeroMovimentoFinanceirovemnull. - Cada notificação traz no máximo 1.000 recebíveis.
- Um mesmo movimento pode ser dividido em mais de um webhook:
- quando o movimento tem mais recebíveis do que o limite por notificação;
- quando os recebíveis do movimento são processados em momentos diferentes.
As partes seguintes chegam com o mesmo NumeroMovimentoFinanceiro, normalmente em poucos minutos.
Totais por notificação
QuantidadeRecebiveiseValorTotalApropriadose referem somente aos recebíveis daquela notificação, e não ao movimento completo. Para obter o total do movimento, some as notificações com o mesmoNumeroMovimentoFinanceiro.
Requisição
| Item | Valor |
|---|---|
| Método | POST |
| Content-Type | application/json; charset=utf-8 |
| Timeout | 60 segundos |
| Sucesso | Qualquer resposta HTTP 2xx |
Corpo
{
"tipo_evento": "RECEBIVEIS_APROPRIADOS",
"data_evento": "2026-11-13T09:15:42",
"dados": {
"NumeroMovimentoFinanceiro": "981392538",
"ConvenioId": 65,
"ValorTotalApropriado": 3.54,
"QuantidadeRecebiveis": 2,
"Recebiveis": [
{
"CobrancaId": null,
"TransacaoId": "3f2b8c1e-6a4d-4e2b-9c7a-1d2e3f4a5b6c",
"RecebivelId": 2086201,
"AntecipacaoId": 876,
"DataAntecipacao": "2026-03-09T15:08:26.82",
"TaxaJuros": 2.99,
"ValorJuros": 0.01,
"ValorLiberado": 1.53,
"ValorIOF": 0.0,
"DataApropriacao": "2026-11-13T09:00:36.823",
"ValorApropriado": 1.54
},
{
"CobrancaId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"TransacaoId": null,
"RecebivelId": 2086202,
"AntecipacaoId": 876,
"DataAntecipacao": "2026-03-09T15:08:26.82",
"TaxaJuros": 2.99,
"ValorJuros": 0.04,
"ValorLiberado": 1.96,
"ValorIOF": 0.0,
"DataApropriacao": "2026-11-13T09:00:36.823",
"ValorApropriado": 2.00
}
]
}
}Envelope
| Campo | Tipo | Descrição |
|---|---|---|
tipo_evento | Texto | Tipo do evento. Para este webhook, sempre RECEBIVEIS_APROPRIADOS |
data_evento | Data/hora | Data e hora da geração do evento (horário de Brasília), no formato yyyy-MM-ddTHH:mm:ss |
dados | Objeto | Dados da apropriação, descritos abaixo |
dados
dados| Campo | Tipo | Descrição |
|---|---|---|
NumeroMovimentoFinanceiro | Texto ou null | Número do movimento financeiro da apropriação. null quando ainda não informado |
ConvenioId | Número | Identificador do convênio de antecipação |
ValorTotalApropriado | Decimal | Soma do ValorApropriado dos recebíveis desta notificação |
QuantidadeRecebiveis | Número | Quantidade de recebíveis desta notificação (máximo de 1.000) |
Recebiveis | Lista | Recebíveis apropriados, descritos abaixo |
dados.Recebiveis[]
dados.Recebiveis[]| Campo | Tipo | Descrição |
|---|---|---|
CobrancaId | GUID ou null | Cobrança de origem do recebível. null quando o recebível é de uma transação |
TransacaoId | GUID ou null | Transação de origem do recebível. null quando o recebível é de uma cobrança |
RecebivelId | Número | Identificador do recebível |
AntecipacaoId | Número | Identificador da antecipação (proposta) |
DataAntecipacao | Data/hora | Data da antecipação |
TaxaJuros | Decimal | Taxa de juros aplicada na antecipação, em percentual |
ValorJuros | Decimal | Valor de juros da antecipação |
ValorLiberado | Decimal | Valor liberado ao cliente na antecipação |
ValorIOF | Decimal | Valor de IOF da antecipação |
DataApropriacao | Data/hora | Data e hora da apropriação |
ValorApropriado | Decimal | Valor apropriado do recebível |
Campos sem valor são enviados como null. As datas seguem o padrão ISO 8601, sem fuso horário.
Entrega e retentativas
- A entrega é considerada bem-sucedida quando o endpoint responde com HTTP
2xxem até 60 segundos. - Em caso de erro (resposta diferente de
2xx, timeout ou falha de conexão), o envio é repetido a cada 30 minutos, até 5 tentativas no total.
Recomendações
- Responda rápido: devolva
2xxassim que receber a notificação e processe os dados em segundo plano. Respostas acima de 60 segundos são tratadas como falha e geram reenvio. - Trate duplicidade: use o
RecebivelIdcomo chave para ignorar recebíveis já processados. Isso cobre reenvios, por exemplo quando a resposta do seu endpoint não chega a tempo. - Não dependa da ordem: as notificações podem chegar fora da ordem cronológica das apropriações.
- Identifique a origem: use
TransacaoIdouCobrancaIdpara localizar a transação ou a cobrança no seu sistema. Só um dos dois vem preenchido.
Updated about 13 hours ago
