Manual Consignado Privado - Averbação de Novos Empréstimos: Autorização e Averbação
Esta página cobre os endpoints e o webhook de sucesso da averbação de uma nova contratação. Para entender por que a garantia funciona dessa forma, veja Regras de Negócio. Para o que fazer quando a averbação falha, veja Erros de Averbação.
1. Autorização
Após a formalização de uma nova contratação de consignado privado, é criada a entidade reservation, utilizada para acompanhar as tentativas de averbação do contrato na DATAPREV e a gestão da garantia após a averbação.
No fluxo ativo, o ambiente pode ser configurado para que a averbação seja criada em um status pendente de autorização ou pode ser criada na fila de averbação — esta configuração deve ser alinhada com o time de operações. No fluxo de leilão, a averbação sempre é criada pendente de autorização.
Quando a averbação é criada com o status pending_requester_authorization, é enviado o webhook:
Webhook Body
{
"webhook_type": "laas.private_payroll.reservation_status_change",
"data": {
"reservation_status": "pending_requester_authorization"
},
"key": "<Debt Key>",
"event_datetime": "2025-04-09T20:00:20Z",
"status": "pending_requester_authorization"
}
Para autorizar a averbação, deve ser enviada a seguinte requisição, identificando a operação pela external_key (o UUID da operação de crédito, o mesmo que debt_key/credit_operation_key):
Este endpoint identifica a operação pela external_key da contratação original. Para autorizar um revínculo (reaverbação em um novo vínculo empregatício), a autorização é feita por reservation_key em um endpoint próprio — ver Movimentação de Vínculos — Averbação por Revínculo.
Request
Response sucesso
Response Body
{
"reservation_key": "<Debt Key>",
"document_number": "12345678901",
"registration_number": "99999999999-A",
"employer_document_number": "12345678901234",
"external_key": "abc123def456",
"contract_number": "2024001234",
"inclusion_date": "2024-03-18",
"disbursement_date": "2024-03-20",
"contract_data": {
"amount": 5000.00,
"installments": 12,
"interest_rate": 0.018
},
"reservation_data": {
"installment_value": 500.00,
"margin_value": 450.00
},
"reservation_status": "authorized"
}
Response falha
Response Body
- Operação não encontrada
- Averbação ainda não está pronta para autorização
- Averbação já está autorizada
{
"title" : "Reservation not found",
"code" : "PRP000035",
"description" : "The reservation was not found",
"translation" : "A reserva não foi encontrada",
}
{
"title" : "Reservation is not ready for authorization",
"code" : "PRP000111",
"description" : "The reservation is not ready for authorization",
"translation" : "A reserva não está pronta para autorização"
}
{
"title" : "Reservation is not pending requester authorization",
"code" : "PRP000057",
"description" : "The reservation is not pending requester authorization",
"translation" : "A reserva não está pendente de autorização do requerente",
}
2. Averbação
Sucesso na averbação
Em caso de sucesso na averbação o parceiro receberá o seguinte webhook:
Webhook Body
{
"webhook": {
"key": "<UUID>",
"data": {
"collateral_data": {},
"collateral_type": "private_payroll",
"collateral_constituted": true
},
"event_time": "2025-07-10 02:15:01",
"webhook_type": "credit_operation.collateral"
}
}
Se a averbação falhar, o parceiro recebe um webhook diferente do de sucesso acima — ver Erros de Averbação.