TravelCaster API - Flights - RetrieveBooking operation

Back to Flights home.

You can access the already booked flight using this transaction. The result of this query will return all booking data, including payment informations, status history and notifications.

Request

JSON

http://endpoint/api/version/FlightService.json/RetrieveBooking

url-encoded parameter: RetrieveBooking([request])

returns: RetrieveBookingResponse

WebService

http://endpoint/api/version/FlightService.asmx

operation: RetrieveBooking

parameters: booking ([request])

returns: RetrieveBookingResponse

Structure of the RetrieveBooking object

 RetrieveBooking
 |_ Token
 |_ TransactionID
 |_ BookingNumber (string)

Structure of the RetrieveBookingResponse object

 RetrieveBookingResponse
 |_ Token
 |_ TransactionID
 |
 |_ BookingNumber
 |_ BookingStatus (int - see notes)
 |_ PaymentStatus (int - see notes)
 |_ BookingDate   (datetime)
 |_ BookingFare   (FlightFare object - see [BookFlight](operation-bookflight) operation result)
 |_ Passengers    (PaxInformation object)
 |_ Buyer         (Buyer object)
 |_ FormOfPayment
 |_ Notifications (array of BookingNotification)
 |  |_ BookingNotification   (See BookingNotifications operation)
 |     |_ BookingNumber
 |     |_ StatusUpdate
 |     |_ StatusText
 |     |_ StatusDate 
 |_ History (array of BookingNotification)
 |  |_ BookingNotification   (See BookingNotifications operation)
 |     |_ BookingNumber
 |     |_ StatusUpdate
 |     |_ StatusText
 |     |_ StatusDate 
 |_ Payments (array of BookingPaymentInformation, provides current payment information)
 |  |_ BookingPaymentInformation
 |     |_ PaymentNumber (int, payment reference number, starts in 1)
 |     |_ FormOfPayment (string, payment type, values are CASH/CARD)
 |     |_ Amount (decimal, payment amount)
 |     |_ Currency (string, ISO-3 currency code)
 |     |_ CreditCardInfo (CreditCardDetails object, see BookFlight operation, if FormOfPayment is CARD, the CardNumber is returned masked)
 |     |_ Status (int, individual payment status, 0 - New, 1 - Accepted, 2 - Denied)
 |     |_ AssignedToPassengers (array of strings, references to each passenger to apply the payment to, use the Number property from the PaxInformation object)
 |     |_ ItemType (string, payment purpose, FARE/FEE/etc)
 |_ ProviderData (array of BookingProviderData, provides booking information supplied by some LowCost booking provider)
 |  |_ BookingProviderData
 |     |_ DataType (string, see below for the list of possible values)
 |     |_ DataValue (string)
 |_ Ancillaries  (object Ancillaries)
 |_ ProviderCode (string - internal code)
 |_ BookingTotalWithAncillaries 
 |_ ProviderRef (string - provider booking reference, used for other queries)
 |_ BookingExternalID (string - *1.6 only* - booking external ID, if provided at booking or updated via API)

Notes

BookingStatus is an integer value which indicates the status of the Booking.

  • 0 = New (Not in use)
  • 1 = Confirmed
  • 2 = UnderRequest (Not in use)
  • 4 = Cancelled
  • 5 = Processed (Not in use)
  • 6 = OnWaitingList (Ticketing error >>> Manual issue required by Matchbox rule)
  • 7 = Issued
  • 9 = Nulled
  • 11 = AwaitingResponse (Enabled only for manual status change)
  • 12 = CC Declined
  • 13 = Void
  • 101 = CancellationRequested
  • 102 = TicketingRequested
  • 200 = TicketingError
  • 300 = Refunded

PaymentStatus is an integer value which indicates the status of the payment. Some values indicate automatic processing, others manual processing.

  • 0 = New
  • 1 = Pending
  • 2 = AdvancePaid
  • 3 = TotalPaid
  • 4 = PendingBank
  • 5 = Return
  • 6 = Denied
  • 7 = OnHold
  • 8 = TotalPaymentGateway
  • 9 = DeniedGateway
  • 10 = AdvancePaymentGateway
  • 11 = Compensation
  • 12 = CompensationPending
  • 14 = PaymentPending
  • 99 = Cancelled

In the BookingProviderData object, DataType is a string value which kind of information was supplied by some LowCost provider.

  • PNR = indicates a provider record locator, if applicable
  • ETICKETLINK = indicates a URL containing e-ticket information
  • TICKETCOUPON = indicates ticket coupon information, in format TicketNumber CouponNumber Origin-Destination CouponStatus FareBasis
  • OTHER = indicates miscellaneous information

Changelog

2024-05-16 v1.6.9.0 Added ItemType to BookingPaymentInformation

Back to Flights home.

See change history for this file
Loading...