Manual Consignado Privado - Movimentação de Vínculos: Consulta de Reservas
Já existe uma consulta de reserva por operação específica, GET /private_payroll/reservation/external_key/{external_key}, documentada em Averbação de Novos Empréstimos — Consulta de Reservas. Aquele endpoint retorna o histórico de tentativas de uma operação de crédito. O endpoint desta página não recebe nenhuma external_key — ele lista e filtra reservas em lote, entre todas as operações do solicitante.
Consulta paginada de reservas
A consulta é sempre restrita às reservas do próprio solicitante autenticado — não é necessário (nem possível) informar o requester_key como filtro. Para acompanhar revínculos em andamento, filtre por reservation_type=transferred.
Query Params
| Campo | Descrição | Tipo | Obrigatório | Valores |
|---|---|---|---|---|
document_number | CPF do trabalhador, para filtrar as reservas de um único tomador | Texto | Não | — |
reservation_type | Filtra pelo método de averbação da reserva — use transferred para localizar revínculos | Texto | Não | new_credit, refinancing, portability, transferred |
reservation_status | Filtra pelo status atual da reserva | Texto | Não | Ver Enumeradores |
page_number | Número da página, começando em 1 | Número | Não (padrão 1) | Mínimo 1 |
page_rows | Quantidade de registros por página | Número | Não (padrão 25) | Entre 1 e 100 |
Response sucesso
Response Body
{
"data": [
{
"reservation_key": "<Reservation Key>",
"requester_key": "123e4567-e89b-12d3-a456-426614174000",
"document_number": "12345678901",
"registration_number": "99999999999-A",
"employer_name": "VIPER SERVICOS DO NORDESTE LTDA",
"admission_date": "2025-04-02",
"employer_document_number": "12345678901234",
"external_key": "123e4567-e89b-12d3-a456-426614174000",
"contract_number": "2024001234",
"inclusion_date": "2025-04-02",
"disbursement_date": "2025-04-05",
"expiration_date": null,
"contract_data": {
"amount": 5000.00,
"installments": 12,
"interest_rate": 0.018
},
"reservation_data": {
"installment_value": 500.00,
"margin_value": 450.00
},
"reservation_type": "transferred",
"reservation_status": "reserved",
"reservation_documents_submission_status": "sent",
"protocols": {},
"next_check_datetime": null,
"next_billing_execution_datetime": null,
"balance_inquiry_data": {},
"periods": [],
"warranty_type": null
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 25
}
}
Cada item de data tem o mesmo formato retornado pelo endpoint de autorização do revínculo. Já pagination.next_page vem null quando a página atual é a última (ou seja, quando a quantidade de itens retornados em data é menor que page_rows); caso contrário, traz o número da próxima página a ser consultada.
Response falha
Quando nenhuma reserva atende aos filtros informados, o endpoint retorna:
Response Body
{
"title": "Reservation not found",
"code": "PRP000035",
"description": "The reservation was not found",
"translation": "A reserva não foi encontrada"
}