Get Booking Level Payment Plans

The GetBookingLevelPaymentPlans Request is an optional call that can be sent after the Basket Prebook Request. This call will uses the same structure as the Basket Prebook Request and returns any Booking Level Payment Plans configured in the Booking Level Payment Plans module that are applicable to the combination of components sent in the request. 

Each Booking Level Payment Plan is returned with an ID node that can then be passed in the Basket Book Request to override the automatically generated Customer Payments and apply the respective Booking Level Payment Plan. This is subject to any components that require an immediate payment greater than the deposit determined by the Booking Level Payment Plan.

Request

The structure of the XML will be:

Response

The structure of the XML will be:

Example XML

Request

After sending the search requests for a Property, Flight and Transfer component, the user sends a GetBookingLevelPaymentPlansRequest with the booking tokens for each component.

<GetBookingLevelPaymentPlansRequest>

    <LoginDetails>

        <Login>test</Login>

        <Password>test</Password>

        <AgentReferece />

    </LoginDetails>

    <PropertyBookings>

        <PropertyPreBookRequest>

            <BookingToken>SxaYaLHPSY5ElLU+MvPLfp8OTAF6ghHdCdPnN7RoAnnTFKqPcjDpUyFW+XUQ</BookingToken>

            <ArrivalDate>2023-06-04T00:00:00+00:00</ArrivalDate>

            <Duration>7</Duration>

            <RoomBookings>

                <RoomBooking>

                    <RoomBookingToken>DqQ6KP6fl8NrmcCltskql27Rsi6+zOEuRfwfbBabm5w=</RoomBookingToken>

                    <GuestConfiguration>

                        <Adults>2</Adults>

                        <Children>0</Children>

                        <Infants>0</Infants>

                    </GuestConfiguration>

                    <OptionalSupplements />

                </RoomBooking>

            </RoomBookings>

            <FlightAndHotel>false</FlightAndHotel>

            <ThirdPartyForceFail>false</ThirdPartyForceFail>

        </PropertyPreBookRequest>

    </PropertyBookings>

    <FlightBookings>

        <FlightPreBookRequest>

            <BookingToken>DTVPDnu2C2jXhy3a3COK9XIS5CK4Z7ZFPXdFN58E73W+oUYrWyTa5XcqXGK9kk=</BookingToken>

            <FlightAndHotel>true</FlightAndHotel>

            <MultiCarrierOutbound>false</MultiCarrierOutbound>

            <MultiCarrierReturn>false</MultiCarrierReturn>

            <SeatMaps>false</SeatMaps>

        </FlightPreBookRequest>

    </FlightBookings>

    <TransferBookings>

        <TransferPreBookRequest>

            <BookingToken>5W5gvz4p1zFJtnoqKgp1aBw2Jzfo1dV/p8iCjpAjMzsdyONTOmlk7DYOWwfHk83kTu8l5aKtYp04K/QSe</BookingToken>

            <DepartureParentType>Airport</DepartureParentType>

            <DepartureParentID>2</DepartureParentID>

            <ArrivalParentType>Resort</ArrivalParentType>

            <ArrivalParentID>387</ArrivalParentID>

            <DepartureDate>2023-06-04</DepartureDate>

            <DepartureTime>10:00</DepartureTime>

            <OneWay>false</OneWay>

            <ReturnDate>2023-06-11</ReturnDate>

            <ReturnTime>10:00</ReturnTime>

            <GuestConfiguration>

                <Adults>2</Adults>

                <Children>0</Children>

                <Infants>0</Infants>

            </GuestConfiguration>

            <OutboundDetails>

                <FlightCode>TBC123</FlightCode>

                <JourneyOrigin>Majorca Airport</JourneyOrigin>

                <AccommodationName>Hotel name</AccommodationName>

            </OutboundDetails>

            <ReturnDetails>

                <FlightCode>TBC321</FlightCode>

            </ReturnDetails>

        </TransferPreBookRequest>

    </TransferBookings>

</GetBookingLevelPaymentPlansRequest>

Response

The Response returns details of any Booking Level Payment Plans that are applicable to this combination of components, in descending order of priority scores.

<GetBookingLevelPaymentPlansResponse>

    <ReturnStatus>

        <Success>true</Success>

        <Exceptions />

        <ThirdPartyErrors />

    </ReturnStatus>

    <BookingLevelPaymentPlans>

        <BookingLevelPaymentPlan>

            <PaymentPlanName>Easyjet Instalments</PaymentPlanName>

            <BookingLevelPaymentPlanID>4</BookingLevelPaymentPlanID>

            <Priority>800</Priority>

            <Payments>

                <Payment>

                    <Sequence>1</Sequence>

                    <PaymentDueDate>2022-11-16T00:00:00+00:00</PaymentDueDate>

                    <AmountDue>270.74</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>2</Sequence>

                    <PaymentDueDate>2022-12-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>3</Sequence>

                    <PaymentDueDate>2023-01-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>4</Sequence>

                    <PaymentDueDate>2023-02-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>5</Sequence>

                    <PaymentDueDate>2023-03-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>6</Sequence>

                    <PaymentDueDate>2023-04-05T10:00:00</PaymentDueDate>

                    <AmountDue>212.61</AmountDue>

                </Payment>

            </Payments>

        </BookingLevelPaymentPlan>

        <BookingLevelPaymentPlan>

            <PaymentPlanName>Default Instalments</PaymentPlanName>

            <BookingLevelPaymentPlanID>3</BookingLevelPaymentPlanID>

            <Priority>700</Priority>

            <Payments>

                <Payment>

                    <Sequence>1</Sequence>

                    <PaymentDueDate>2022-11-16T00:00:00+00:00</PaymentDueDate>

                    <AmountDue>270.74</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>2</Sequence>

                    <PaymentDueDate>2022-12-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>3</Sequence>

                    <PaymentDueDate>2023-01-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>4</Sequence>

                    <PaymentDueDate>2023-02-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>5</Sequence>

                    <PaymentDueDate>2023-03-16T08:00:00</PaymentDueDate>

                    <AmountDue>212.59</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>6</Sequence>

                    <PaymentDueDate>2023-04-05T10:00:00</PaymentDueDate>

                    <AmountDue>212.61</AmountDue>

                </Payment>

            </Payments>

        </BookingLevelPaymentPlan>

        <BookingLevelPaymentPlan>

            <PaymentPlanName>Default Deposit</PaymentPlanName>

            <BookingLevelPaymentPlanID>2</BookingLevelPaymentPlanID>

            <Priority>1</Priority>

            <Payments>

                <Payment>

                    <Sequence>1</Sequence>

                    <PaymentDueDate>2022-11-16T00:00:00+00:00</PaymentDueDate>

                    <AmountDue>400.00</AmountDue>

                </Payment>

                <Payment>

                    <Sequence>2</Sequence>

                    <PaymentDueDate>2023-04-05T10:00:00</PaymentDueDate>

                    <AmountDue>933.71</AmountDue>

                </Payment>

            </Payments>

        </BookingLevelPaymentPlan>

    </BookingLevelPaymentPlans>

</GetBookingLevelPaymentPlansResponse>

The User can then choose one of these Booking Level Payment Plans to apply to the booking by entering the respective BookingLevelPaymentPlanID returned in the response into the BookingPaymentPlanOverrideID node in the Basket Book Request

Next

>> Basket Book

Related Pages

> Basket Prebook

> Property Prebook

> Flight Prebook

> Transfer Prebook

> Extra Prebook