To use this endpoint, the payment method which could be a card or check. Once the payment method has been selected, the appropriate payment information must be entered, such as the credit card number, expiration date, and require fields
In addition to the payment information, must provide contact information, such as the name and email address of the person making the booking. This information is necessary to confirm the payment and complete the booking process.
Schema
Document
-
Name: Provide the name for the request. This is a String value.
-
ReferenceVersion: Provide the version number. This is a Numeric value.
Party
-
Travel Agency Sender:
-
Name: Provide the name for the request. This is a String value.
-
IATA Number: Provide the IATA number for the request. This is a String value.
-
Agency ID: Provide the agency ID for the request. This is a String value.
-
Contacts: This is an Array.
- EmailContact: Provide the email contact for the request. This is a String value.
-
Query
-
OrderID: This is the unique identifier that is typically provided by the airline at the time of booking. This is the required field, and the value will be string.
-
GdsBookingReference: This is the code that is used by GDS to identify the booking. The GDS booking references are typically provided by the airlines at the time of booking. This is the required field, and the value will be the String
Note: GDS- Global Distribution System.
Payments
-
Payments: This is an Array.
-
Type: This is a required field. Provide the payment type. Valid values are
CardandCheque. This is a String value. -
Amount: This is a required field. Provide the amount. This is a Numeric value.
-
ChequeNumber: This is a required field. Provide the cheque number. This is a String value.
-
DataLists
- ContactInformation: This is an Array and a required field. Provide all the contact information here.
-
ContactID: Provide the contact ID.
-
AgencyName: Provide the agency name.
-
EmailAddress: Provide the email address.
-
Phone:
- ContryCode: Provide the country code.
- AreaCode: Provide the area code.
- PhoneNumber: Provide the phone number.
-
Mobile:
- CountryCode: Provide the country code.
- MobileNumber: Provide the mobile number.
-
Address:
- Street: This is an Array. Provide the street details.
- CityName: Provide the city name.
- StateProv: Provide the state province.
- PostalCode: Provide the postal code.
- CountryCode: Provide the country code.
-
PassengerContact: Provide the contact details.
-
EmailAddress: Provide you email ID. This is a String value.
-
Phone: Provide your phone details.
-
CountryCode: Provide the country code. This is a Numeric value.
-
AreaCode: Provide the area code. This is a Numeric value.
-
PhoneNumber: Provide the phone number. This is a Numeric value.
-
-
-
Request URL
curl --location --request POST 'https://uat-apigateway.voyzantonline.com/AirOrderChange' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
Request Body Sample
{
"OrderChangeRQ": {
"Document": {
"Name": "SkyBlue Tours B2B",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "SkyBlue Tours and Travels",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": [
{
"EmailContact": "skyblueb2b@gmail.com"
}
]
}
}
}
},
"Query": {
"OrderID": "3UW6QY46",
"GdsBookingReference": ["N11J4W"]
},
"Payments": {
"Payment": [
{
"Type": "CHECK",
"Amount": "292.07",
"ChequeNumber": "3232323"
}
]
},
"DataLists": {
"ContactList": {
"ContactInformation": [
{
"ContactID": "CTC1",
"AgencyName": "kathir",
"EmailAddress": "kathir@gmail.com",
"Phone": {
"ContryCode": "+91",
"AreaCode": "",
"PhoneNumber": "9854785465"
},
"Mobile": {
"ContryCode": "+91",
"MobileNumber": "9854785465"
},
"Address": {
"Street": [
"testing address1",
null
],
"CityName": "chennai",
"StateProv": "AX",
"PostalCode": "123465",
"CountryCode": "CA"
},
"PassengerContact": {
"EmailAddress": "mosris@gmail.com",
"Phone": {
"ContryCode": "",
"AreaCode": "",
"PhoneNumber": "9856325698"
}
}
}
]
}
}
}
}
Response Sample
{
"OrderViewRS": {
"Document": {
"Name": "
Voyzant API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "kathir",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": [
{
"EmailContact": "kathir@gmail.com"
}
]
}
}
}
},
"ShoppingResponseId": "1619686840837476242",
"Success": {},
"Order": [
{
"OrderID": "3UW6QY46",
"GdsBookingReference": "N11J4W",
"NeedToTicket": "N",
"OfferID": "153211619686844093122436",
"Owner": "AA",
"OwnerName": "American Airlines",
"IsBrandedFare": "Y",
"CabinOptions": [],
"IsAdditionalCabinType": "N",
"TimeLimits": {
"OfferExpirationDateTime": "2021-04-29T17:00:02"
},
"BookingCurrencyCode": "CAD",
"EquivCurrencyCode": "CAD",
"RewardSettings": {
"RewardAvailable": "N",
"PointTypes": [],
"PointValues": {}
},
"BookingFeeInfo": {
"FeeType": "",
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"TotalPrice": {
"BookingCurrencyPrice": 292.073,
"EquivCurrencyPrice": 292.073
},
"BasePrice": {
"BookingCurrencyPrice": 222.173,
"EquivCurrencyPrice": 222.173
},
"TaxPrice": {
"BookingCurrencyPrice": 69.9,
"EquivCurrencyPrice": 69.9
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"Penalty": {
"ChangeFee": {
"Before": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
},
"CancelationFee": {
"Before": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
}
},
"PaxSeatInfo": [],
"OfferItem": [
{
"OfferItemID": "OFFERITEMID1",
"Refundable": "false",
"PassengerType": "ADT",
"PassengerQuantity": 2,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 194.6865,
"EquivCurrencyPrice": 194.6865
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "ADT1 ADT2",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "ADT1 ADT2",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 194.6865,
"EquivCurrencyPrice": 194.6865
},
"BaseAmount": {
"BookingCurrencyPrice": 148.0865,
"EquivCurrencyPrice": 148.0865
},
"TaxAmount": {
"BookingCurrencyPrice": 46.6,
"EquivCurrencyPrice": 46.6
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"BookingFee": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"Taxes": [
{
"TaxCode": "US",
"BookingCurrencyPrice": 11,
"EquivCurrencyPrice": 11
},
{
"TaxCode": "ZP",
"BookingCurrencyPrice": 10.6,
"EquivCurrencyPrice": 10.6
},
{
"TaxCode": "AY",
"BookingCurrencyPrice": 13.8,
"EquivCurrencyPrice": 13.8
},
{
"TaxCode": "XF",
"BookingCurrencyPrice": 11.2,
"EquivCurrencyPrice": 11.2
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1",
"Code": "NVAKZNN1"
},
"RBD": "N",
"CabinType": "Y",
"SeatLeft": "4"
}
}
]
},
{
"OfferItemID": "OFFERITEMID2",
"Refundable": "false",
"PassengerType": "CHD",
"PassengerQuantity": 1,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 97.34325,
"EquivCurrencyPrice": 97.34325
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "CHD1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "CHD1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 97.34325,
"EquivCurrencyPrice": 97.34325
},
"BaseAmount": {
"BookingCurrencyPrice": 74.04325,
"EquivCurrencyPrice": 74.04325
},
"TaxAmount": {
"BookingCurrencyPrice": 23.3,
"EquivCurrencyPrice": 23.3
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"BookingFee": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"Taxes": [
{
"TaxCode": "US",
"BookingCurrencyPrice": 5.5,
"EquivCurrencyPrice": 5.5
},
{
"TaxCode": "ZP",
"BookingCurrencyPrice": 5.3,
"EquivCurrencyPrice": 5.3
},
{
"TaxCode": "AY",
"BookingCurrencyPrice": 6.9,
"EquivCurrencyPrice": 6.9
},
{
"TaxCode": "XF",
"BookingCurrencyPrice": 5.6,
"EquivCurrencyPrice": 5.6
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1",
"Code": "NVAKZNN1"
},
"RBD": "N",
"CabinType": "Y",
"SeatLeft": "4"
}
}
]
},
{
"OfferItemID": "OFFERITEMID3",
"Refundable": "false",
"PassengerType": "INF",
"PassengerQuantity": 1,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 0.04325,
"EquivCurrencyPrice": 0.04325
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "INF1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "INF1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 0.04325,
"EquivCurrencyPrice": 0.04325
},
"BaseAmount": {
"BookingCurrencyPrice": 0.04325,
"EquivCurrencyPrice": 0.04325
},
"TaxAmount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"BookingFee": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"Taxes": []
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1",
"Code": "NVAKZNN1"
},
"RBD": "N",
"CabinType": "Y",
"SeatLeft": "4"
}
}
]
}
],
"BaggageAllowance": [
{
"SegmentRefs": "Segment1",
"PassengerRefs": "ADT1 ADT2",
"BaggageAllowanceRef": "Bag1"
},
{
"SegmentRefs": "Segment1",
"PassengerRefs": "CHD3",
"BaggageAllowanceRef": "Bag1"
},
{
"SegmentRefs": "Segment1",
"PassengerRefs": "INF4",
"BaggageAllowanceRef": "Bag1"
}
],
"BookingToEquivExRate": 1,
"FopRef": "FOP_5_5_32_0_AA"
}
],
"DataLists": {
"PassengerList": {
"Passengers": [
{
"attributes": {
"PassengerID": "ADT1"
},
"PassengerID": "ADT1",
"PTC": "ADT",
"BirthDate": "2000-07-21",
"NameTitle": "Mr",
"FirstName": "downey",
"MiddleName": "",
"LastName": "Robert",
"TravelDocument": {
"DocumentNumber": "9658745",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA",
"DocumentType": ""
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"ContactInfoRef": "CTC1"
},
{
"attributes": {
"PassengerID": "ADT2"
},
"PassengerID": "ADT2",
"PTC": "ADT",
"BirthDate": "2000-08-21",
"NameTitle": "Mr",
"FirstName": "Crish",
"MiddleName": "",
"LastName": "Evans",
"TravelDocument": {
"DocumentNumber": "965872345",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA",
"DocumentType": ""
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"ContactInfoRef": "CTC1"
},
{
"attributes": {
"PassengerID": "CHD3"
},
"PassengerID": "CHD3",
"PTC": "CHD",
"BirthDate": "2014-08-21",
"NameTitle": "Mr",
"FirstName": "Mark",
"MiddleName": "",
"LastName": "Ruffllo",
"TravelDocument": {
"DocumentNumber": "96587234",
"ExpiryDate": "2023-01-01",
"IssuingCountry": "CA",
"DocumentType": ""
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"ContactInfoRef": "CTC1"
},
{
"attributes": {
"PassengerID": "INF4"
},
"PassengerID": "INF4",
"PTC": "INF",
"BirthDate": "2020-08-21",
"NameTitle": "Mr",
"FirstName": "Stepen",
"MiddleName": "",
"LastName": "Strang",
"TravelDocument": {
"DocumentNumber": "965872345",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA",
"DocumentType": ""
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"ContactInfoRef": "CTC1"
}
]
},
"DisclosureList": {
"Disclosures": []
},
"FareList": {
"FareGroup": [
{
"FareGroupRef": "FG_1",
"FareCode": "70J",
"FareBasisCode": "NVAKZNN1"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "LAX",
"Date": "2021-08-20",
"Time": "16:58:00",
"AirportName": "Los Angeles International Airport",
"Terminal": {
"Name": "0"
}
},
"Arrival": {
"AirportCode": "SFO",
"Date": "2021-08-20",
"Time": "18:22:00",
"AirportName": "San Francisco International Airport",
"Terminal": {
"Name": "1"
}
},
"MarketingCarrier": {
"AirlineID": "AA",
"Name": "American Airlines",
"FlightNumber": "2012"
},
"OperatingCarrier": {
"AirlineID": "AA",
"Name": "American Airlines",
"FlightNumber": "2012"
},
"Equipment": {
"AircraftCode": "Airbus A321-100/200",
"Name": "Airbus A321-100/200"
},
"Code": {
"MarriageGroup": ""
},
"FlightDetail": {
"FlightDuration": {
"Value": "1 Hrs 24 Min"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": "0"
},
"BrandId": "Main Cabin"
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "-2 H -36 M",
"Stops": 0
},
"SegmentReferences": "Segment1"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "LAX",
"ArrivalCode": "SFO",
"FlightReferences": "Flight1"
}
]
},
"PriceClassList": {
"PriceClass": [
{
"PriceClassID": "PCR_1",
"Name": "Main Cabin",
"Code": "Main Cabin",
"Descriptions": {
"Description": []
}
}
]
},
"BaggageAllowanceList": {
"BaggageAllowance": [
{
"BaggageAllowanceID": "Bag1",
"BaggageCategory": "Checked",
"AllowanceDescription": {
"ApplicableParty": "Traveler",
"Description": "CHECKED ALLOWANCE"
},
"PieceAllowance": {
"ApplicableParty": "Traveler",
"TotalQuantity": "undefined",
"Unit": "Pieces"
}
}
]
},
"FopList": [
{
"CC": {
"Allowed": "Y",
"Types": {
"AX": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
}
},
"DC": {
"Allowed": "Y",
"Types": {
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"RU": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
}
},
"CASH": {
"Allowed": "Y",
"Types": {}
},
"CHEQUE": {
"Allowed": "Y",
"Types": {}
},
"ACH": {
"Allowed": "Y",
"Types": {}
},
"PG": {
"Allowed": "Y",
"Types": {}
},
"FopKey": "FOP_5_5_32_0_AA"
}
]
}
}
}