Booking Hold and Resume

Rapid's Hold and Resume functionality gives you the ability to support a 2-step booking model.

Please see here for more information on Hold and Resume.

1. Shop

Get availability

GetAvailabilityOperationParams getAvailabilityOperationParams = GetAvailabilityOperationParams.builder()
    .checkin("YYYY-MM-DD")
    .checkout("YYYY-MM-DD")
    .currency("USD")
    .language("en_US")
    .countryCode("US")
    .occupancy(List.of("OCCUPANCY"))
    .propertyId(List.of("PROPERTY ID"))
    .customerIp("127.0.0.1")
    .ratePlanCount(BigDecimal.ONE)
    .salesChannel("SALES CHANNEL")
    .salesEnvironment("SALES ENVIRONMENT")
    .build();

GetAvailabilityOperation getAvailabilityOperation = new GetAvailabilityOperation(getAvailabilityOperationParams);
Response<List<Property>> propertiesResponse = rapidClient.execute(getAvailabilityOperation);

Get price check token

String getPriceCheckToken(PropertyAvailability propertyAvailability) throws MalformedURLException {
        return rapidClient.helpers.extractToken(propertyAvailability.getRooms().get(0).getRates().get(0).getBedGroups().entrySet().stream().findFirst().get().getValue().getLinks().getPriceCheck().getHref());
}

Check room prices

Property property = propertiesResponse.getBody().get(0);

if (property instanceof PropertyAvailability) {
    PropertyAvailability propertyAvailability = (PropertyAvailability)property;
    PriceCheckOperationParams priceCheckOperationParams = PriceCheckOperationParams.builder()
        .propertyId("PROPERTY ID")
        .roomId(propertyAvailability.getRooms().get(0).getId())
        .rateId(propertyAvailability.getRooms().get(0).getRates().get(0).getId())
        .token(getPriceCheckToken(propertyAvailability))
        .build();
    Response<RoomPriceCheck> response = rapidClient.execute(new PriceCheckOperation(priceCheckOperationParams));
    RoomPriceCheck roomPriceCheck = response.getBody();
}

2. Book

Get post itinerary token and create itinerary request

String getPostItineraryToken(RoomPriceCheck priceCheck) throws MalformedURLException {
        return rapidClient.helpers.extractToken(priceCheck.getLinks().getBook().getHref());
}

CreateItineraryRequest createItineraryRequest(boolean hold) {
        PhoneRequest phone =
                PhoneRequest.builder()
                        .countryCode("COUNTRY CODE")
                        .areaCode("AREA CODE")
                        .number("NUMBER")
                        .build();

        List<CreateItineraryRequestRoom> rooms = List.of(
                CreateItineraryRequestRoom.builder()
                        .givenName("John")
                        .familyName("Smith")
                        .smoking(false)
                        .specialRequest("SPECIAL REQUEST")
                        .build()
        );

        BillingContactRequestAddress address =
                BillingContactRequestAddress.builder()
                        .line1("LINE 1")
                        .line2("LINE 2")
                        .line3("LINE 3")
                        .city("CITY")
                        .stateProvinceCode("STATE CODE")
                        .countryCode("COUNTRY CODE")
                        .postalCode("POSTAL CODE")
                        .build();

        BillingContactRequest billingContact =
                BillingContactRequest.builder()
                        .givenName("John")
                        .familyName("Smith")
                        .address(address)
                        .build();

        List<PaymentRequest> payments = List.of(
                PaymentRequest.builder()
                        .type(PaymentRequest.Type.CUSTOMER_CARD)
                        .number("NUMBER")
                        .securityCode("SECURITY CODE")
                        .expirationMonth("MONTH")
                        .expirationYear("YEAR")
                        .billingContact(billingContact)
                        .enrollmentDate("ENROLLMENT_DATE")
                        .build()
        );

        return CreateItineraryRequest.builder()
                .affiliateReferenceId(UUID.randomUUID().toString().substring(0, 28))
                .hold(hold)
                .email("john@example.com")
                .phone(phone)
                .rooms(rooms)
                .payments(payments)
                .affiliateMetadata("AFFILIATE METADATA")
                .taxRegistrationNumber("TAX NUMBER")
                .travelerHandlingInstructions("INSTRUCTIONS")
                .build();
}

Create itinerary

PostItineraryOperationParams itineraryCreationParams = PostItineraryOperationParams
    .builder()
    .customerIp("CUSTOMER IP")
    .token(getPostItineraryToken(roomPriceCheck))
    .build();

PostItineraryOperation itineraryCreationOperation = new PostItineraryOperation(createItineraryRequest(true), itineraryCreationParams);

Response<ItineraryCreation> response = rapidClient.execute(itineraryCreationOperation);
ItineraryCreation itineraryCreationResponse = response.getBody();

Get resume booking token

String getResumeBookingToken(ItineraryCreation itineraryCreation) throws MalformedURLException {
        return rapidClient.helpers.extractToken(itineraryCreation.getLinks().getResume().getHref());
}

Resume on-hold booking

PutResumeBookingOperationParams itineraryResumeParams = PutResumeBookingOperationParams
    .builder()
    .customerIp("CUSTOMER IP")
    .itineraryId(itineraryCreationResponse.getItineraryId())
    .token(getResumeBookingToken(itineraryCreation))
    .build();

PutResumeBookingOperation itineraryResumeOperation = new PutResumeBookingOperation(itineraryResumeParams);
rapidClient.execute(itineraryResumeOperation);
Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve Developer Hub!