Aprovação de Reserva

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações.

Quando a configuração do requester define que reservas precisam de aprovação manual (allow_reservation: false), toda nova reserva é criada com is_allowed_to_reserve = false. Nesse estado, a reserva permanece em pending_reservation e não é processada pela rotina automática — fica aguardando uma aprovação explícita.

Este endpoint libera a reserva manualmente, alterando is_allowed_to_reserve para true. A partir daí, o próximo ciclo da rotina automática avança a reserva para pending_reservation_confirmation (veja Mapa de Status).

O status da reserva não muda com a chamada

O reservation_status continua pending_reservation antes e depois do approve. O que muda é o flag is_allowed_to_reserve, que destrava o processamento automático. O avanço para pending_reservation_confirmation acontece na próxima execução da rotina.

Aprovar Reserva

ENDPOINT

/vehicle_collateral/external_key/EXTERNAL-KEY/reservation/approve

MÉTODO

POST

O EXTERNAL-KEY é o identificador único da operação (mesmo valor usado em outras consultas de garantia veicular). A requisição não exige body.

Response Body (200)

{
    "reservation_key": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
    "external_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "reservation_status": "pending_reservation",
    "is_allowed_to_reserve": true,
    "document_number": "12345678901",
    "inclusion_date": "2026-06-15"
}

Campos da Response

Campo	Tipo	Descrição
reservation_key	String (UUID)	Identificador interno da reserva
external_key	String (UUID)	Identificador da operação (mesmo enviado na URL)
reservation_status	String	Status atual da reserva. Permanece pending_reservation após o approve (ver Mapa de Status)
is_allowed_to_reserve	Boolean	true após a aprovação — libera o processamento automático
document_number	String	CPF/CNPJ do tomador
inclusion_date	String (YYYY-MM-DD)	Data de criação da reserva

Idempotência

Chamar o endpoint quando is_allowed_to_reserve já é true retorna 200 normalmente, sem alterar o estado. Pode ser usado com segurança em retries.

Validação de propriedade

A reserva precisa pertencer ao requester autenticado. Caso contrário, a resposta é 404 Not Found.