FNRH Digital API Documentation

3) Consultar check-in

Retorna os dados consolidados da reserva/check-in e a lista de hospedes vinculados.

O objeto reservation retorna os mesmos campos consolidados do upsert. O array guests traz os dados cadastrados de cada hospede.

{
  "success": true,
  "reservation": {
    "id": 123,
    "reservation_code": "RES-12345",
    "status": "PENDING",
    "checkin_status": "PENDING",
    "checkout_status": "PENDING",
    "arrival_date": "2026-02-20",
    "departure_date": "2026-02-23",
    "check_in_at": null,
    "check_out_at": null,
    "unit": "101",
    "adults": 2,
    "children": 1,
    "ota_source": "Booking.com",
    "travel_reason": "LAZER_FERIAS",
    "transport_type": "AUTOMOVEL",
    "origin_city": "Sao Paulo/SP",
    "destination_city": "Rio de Janeiro/RJ",
    "guest_name": "Maria Souza",
    "guest_contact": "11999998888",
    "created_at": "2026-03-19 10:00:00",
    "updated_at": "2026-03-19 10:05:00"
  },
  "guests_count": 2,
  "guests": [
    {
      "id": 456,
      "name": "Maria Souza",
      "social_name": null,
      "doc_type": "cpf",
      "doc_number": "12345678901",
      "birth_date": "1990-01-01",
      "gender": "MULHER",
      "raca": "BRANCA",
      "has_disability": "NAO",
      "disability_type": null,
      "tipo_nacionalidade": "BRASILEIRO",
      "nationality": "BR",
      "profession": "Engenheira",
      "email": "maria@email.com",
      "phone": "11999998888",
      "address_country": "Brasil",
      "address_street": "Rua A",
      "address_number": "123",
      "address_complement": "Apto 12",
      "address_neighborhood": "Centro",
      "address_city": "Sao Paulo",
      "address_state": "SP",
      "address_zip": "01001-000",
      "passport_country": null,
      "is_primary": true
    }
  ]
}

3.1) Webhook opcional de pre-check-in

Quando habilitado, o sistema envia automaticamente um POST para a URL configurada assim que o hospede conclui o pre-check-in.

Evento enviado: precheckin.completed. O payload espelha o retorno do GET /reservas/{reservation_code} e inclui event e hotel_id.

Autenticacao outbound por header customizado. Por padrao usamos X-Sisteminter-Webhook-Token, mas o nome pode ser ajustado na implantacao. Em caso de falha, o envio entra em fila com retries automaticos.

POST URL_WEBHOOK_CONFIGURADA
Content-Type: application/json
X-Webhook-Event: precheckin.completed
X-Webhook-Idempotency-Key: <hash>
X-Sisteminter-Webhook-Token: <secret>

{
  "event": "precheckin.completed",
  "hotel_id": 1,
  "reservation": {
    "reservation_code": "RES-12345",
    "travel_reason": "LAZER_FERIAS",
    "transport_type": "AUTOMOVEL",
    "origin_city": "Sao Paulo/SP",
    "destination_city": "Rio de Janeiro/RJ",
    "guest_name": "Maria Souza"
  },
  "guests_count": 2,
  "guests": [
    {
      "name": "Maria Souza",
      "doc_type": "cpf",
      "doc_number": "12345678901",
      "is_primary": true
    }
  ]
}