Purchase request data dictionary | Allianz Partner Services

Object	Element	Definition	Required	Type	Example	Notes
Partner	`UserID`	User ID assigned by AWP. AWP will validate each request using Partner’s ACCAM, User ID and Password.	R	string	”test”
Partner	`Password`	Partner’s password that is provided by AWP.	R	string	”test”
PurchaseRequest	`Accam`	AWP’s company identifier for the partner.	R	string	”F123456”
PurchaseRequest	`BusinessUnit`	This is the business unit that processes the purchase request or point of sale location	R	string	”US, UK, CA”
PurchaseRequest	`TransactionID`	Unique identifier for each XML transaction (request and response) that is generated by the partner. Typically a cart number	R	string	”ABC0000 0001”
Purchases	`PartnerBookingID`	Unique identifier for the travel booking and purchase date that is generated by the partner. i.e. PNR. This number must be unique per calendar day	R	string	”ABC123”
InsuranceBookingDetails	`PurchaseDateTime`	Date and time that the insurance purchase was made.	R	date/ti me	”2012-04- 3010:00:0 0”
InsuranceBookingDetails	`CoSourceID`	The cosource id, marketing id, or banner id that resulted in insurance being purchased.	O	string	”1234”
InsuranceBookingDetails	`ReferringURL`	The referring URL that is related to insurance being purchased.	O	string	”URL”
InsuranceBookingDetails	Opt. (O)	Details
InsuranceBookingDetails	`Status`	The billing status for this insurance booking.	R	string	”NEW, CHARGED “	Typically the value is NEW. CHARGED only applies if AWP is not the merchant of record; in that case CC details are not required
InsuranceBookingDetails	`Type`	The transaction type for the insurance booking.	R	string	”ADD, CNCL, CANCEL, CHNG, CHANGE”	ADD is used for all new bookings
InsuranceBookingDetails	`Currency`	The local, 3 digit ISO currency code	R	string	”USD”
InsuranceBookingDetails	TotalCoverageAmou nt	The total trip cost to be covered by the insurance purchase.	R	double	”500”
InsuranceBookingDetails	`TotalPrice`	The total price for the insurance purchase including premium and taxes.	R	double	”27.50”
InsuranceBookingDetails	`WaiverPrice`	double
InsuranceBookingDetails	`TotalTaxes`	The total taxes for the insurance purchase.	O	double	”0”
InsuranceBookingDetails	TotalCharitableContr ibution	The total charitable contributions for the insurance purchase.	O	double	”0”
InsuranceBookingDetails	`TaxRegion`	The tax region or code that identifies the tax rate that applies to this insurance booking.	O	string	”XX”	Not applicable if the point of sale is in the US
InsuranceBookingDetails	`PromotionCode`	The promotion code used to complete this insurance booking.	O	string	”AB13”
InsuranceBookingDetails	Opt. (O)	Details
InsuranceBookingDetails	SubscribeToMarketi ng	A flag that indicates whether or not the purchaser or partner would like marketing material sent from AWP to the purchaser.	O	boolean	”FALSE”
InsuranceBookingDetails / Purchaser	`FirstName`	Purchaser’s first name.	R	string	”Chris”
InsuranceBookingDetails / Purchaser	`MiddleInitial`	Purchaser’s middle initial.	O	string	”S”
InsuranceBookingDetails / Purchaser	`LastName`	Purchaser’s last name.	R	string	”Smith”
InsuranceBookingDetails / Purchaser / BillingAddress	`Street`	The billing street address.	R	string	”9950 Mayland Dr”
InsuranceBookingDetails / Purchaser / BillingAddress	`Street2`	The billing street address - 2nd line.	O	string	”Ste 100”
InsuranceBookingDetails / Purchaser / BillingAddress	`City`	The billing city.	R	string	”Richmon d”
InsuranceBookingDetails / Purchaser / BillingAddress	`Region`	The two digit state or province code.	R	string	”VA”	Required for all U.S. and Canadian addresses only
InsuranceBookingDetails / Purchaser / BillingAddress	`PostalCode`	The billing zip code or postal code.	R	string	”23233”
InsuranceBookingDetails / Purchaser / BillingAddress	`Country`	The billing ISO 3 digit country code.	R	string	”USA”
InsuranceBookingDetails / Purchaser	`EmailAddress`	Purchaser’s email address. Required if fulfillment method is EMAIL.	O	string	”test@tes t.com”	Required if E- mail is the chosen method of policy fulfillment
InsuranceBookingDetails / Purchaser	SecondaryEmailAddr ess	A second email address that fulfillment will be sent to on behalf of the purchaser if the fulfillment method is EMAIL.	O	string	”test@tes t.com”
InsuranceBookingDetails / Purchaser	Opt. (O)	Details
InsuranceBookingDetails / Purchaser	`PhoneNumber`	Purchaser’s phone number.	O	long	”8041234 567”	Strongly recommended that this is sent
InsuranceBookingDetails / Purchaser	`FaxNumber`	Purchaser’s fax number	O	long	Example “999-999- 999”
InsuranceBookingDetails / Purchaser	`MembershipStatus`	Indicates if the Primary Booker is singed in or booking as a guest.	O	string	“Guest”
InsuranceBookingDetails / Purchaser	`UsePromotionCode`	Tracks whether or not a unique promotional code is being used”	O	boolean	“true”
InsuranceBookingDetails / Purchaser	`TripIndicator`	The type of trip being booked	O	String	“One_Wa y”
InsuranceBookingDetails / Purchaser	`DiscountType`	The type of discount being provided.	O	String	“Military”
InsuranceBookingDetails / Purchaser	TicketDeliveryMetho d	The method the customer wants to receive the ticket, such as electronic or paper ticket.	O	String	“electroni c”
InsuranceBookingDetails (repeatable)	`FulfillmentMethod`	Fulfillment method for insurance purchase. Valid values include ‘EMAIL’ and ‘MAIL’	R	string	”EMAIL”
InsuranceBookingDetails (repeatable)	`PaymentMethod`	Payment method for insurance purchase. Valid values include ‘CC’ and ‘CW’	R	string	”CC”	CC = Credit Card, CW = Cash Withheld.
InsuranceBookingDetails (repeatable)	PaymentTransaction ID	Payment transaction id from payment processor.	O	string	”123456”	Only applicable if client is charging the CC. Field limit 12 characters
InsuranceBookingDetails (repeatable)	PaymentReconciliati onID	Payment reconciliation id from payment processor.	O	string	”123456”	and AWP is MOR)
InsuranceBookingDetails (repeatable)	`CardholderName`	The name that appears on the credit card.	R	string	”Chris Smith”
InsuranceBookingDetails (repeatable)	`ExpireMonth`	The month the credit card expires.	R	int	”11”
InsuranceBookingDetails (repeatable)	Opt. (O)	Details
InsuranceBookingDetails (repeatable)	`ExpireYear`	The 4 digit year the credit card expires.	R	int	”2014”
InsuranceBookingDetails (repeatable)	`CardNumber`	The credit card number.	R	long	”Card Number”
InsuranceBookingDetails (repeatable)	`CardType`	The credit card type. Valid values include AE, AX,AO = American Express	R	string	”VI”	JC = JCB
InsuranceBookingDetails (repeatable)	`SecurityCode`	The security or verification code that appears on the back of the credit card.	O	int	”123”	Required for some sales outside the US (i.e. UK)
InsuranceBookingDetails (repeatable)	`TravelAgent`	The identifier for the travel agent who assisted with the insurance purchase. Min length: 0; Max length: 40 chars.	O	string	”CSS”	Recommended to identify selling agent for reporting
InsuranceBookingDetails (repeatable)	`AccountUserType`	The AWP account user type. An account is either for an agent (A) or consumer (C).	O	string	”A”
InsuranceBookingDetails (repeatable)	`AccountUserName`	The AWP account user name.	O	string	”test”
InsuranceBookingDetails (repeatable)	`Description`	Description of additional option	O	string
InsuranceBookingDetails (repeatable)	`Cost`	Cost of additional item.	O	double
InsuranceBookingDetails (repeatable)	`CurrencyType`	The 3 digit ISO currency code.	O	string	“USD”
InsuranceBookingDetails (repeatable)	Opt. (O)	Details
GadgetDetails	`BrowserType`	The browser being used by the customer.	O	string	”IE”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	`BrowserVersion`	The version number of the browser being used by the customer.	O	string	”1.2”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	`DeviceCategory`	The device being used (mobile, tablet, desktop)	O	string	”Tablet”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	`DeviceType`	The type of device on which the offer is to be presented, i.e.,iphone, Nexus PC or Mac.	O	string	”iphone”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	`OperatingSystem`	The operating system on which the offer is to be presented. (i.e. iOS, Blackberry, Android, etc.)	O	string	”Android”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	OperatingSystemVer sion	The version of the operating system on which the offer is to be presented.	O	string	”4.2”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	Opt. (O)	Details
GadgetDetails	`RequestingPlatform`	The mobile platform on which the offer is to be presented. (i.e. Mobile Site or Mobile App)	O	string	”Mobile App”	Required if insurance is offered via mobile website or mobile application
GadgetDetails	RequestingPlatform Version	The version of the requesting platform on which the offer is to be presented.	O	string	”Macintos h OSX”	Required if insurance is offered via mobile website or mobile application
TravelBookingDetails	`Currency`	The 3 digit ISO currency code.	R	string	”USD”
TravelBookingDetails	`TotalTripCost`	Total trip cost for all travelers in the booking.	O	double	”500.00”	If this element is passed its value should match that of TotalCoverageA mount
TravelBookingDetails	`TotalMiles`	The total airline miles used for the travel booking.	O	int	”5000”
TravelBookingDetails / TripCostIncludes	`Item`	List of items included in the total trip cost. Valid values include air, car, cruise, event, hotel, package, rail, tour.	O	array	”Air, Cruise”
TravelBookingDetails	`DepositDate`	The date the first payment for the booking is made by the customer. If unsure of this date please use the policy purchase date	O	date/ti me	”2012-04- 30:10:00: 00”	Desired to identify eligibility for coverage by product
TravelBookingDetails	Opt. (O)	Details
TravelBookingDetails	`FinalPaymentDate`	The date the final payment for the booking is made by the customer.	O	date/ti me	”2012-04- 30:10:00: 00”	Desired to identify eligibility for coverage (only applicable for specific products)
TravelBookingDetails	`CustomerID`	The customer identifier, frequent flyer number, or membership number for the customer who made the travel booking.	O	string	”1234”
TravelBookingDetails	`TravelAgent`	The identifier for the agent who completed the booking for the customer.	O	string	”CSS”	Desired to identify selling agent for reporting
TravelBookingDetails	`Language`	The ISO language code used to complete the travel booking.	O	string	”ENG”
TravelDetails	`DepartureDate`	The first date of travel.	R	date/ti me	”2012-06- 01:10:00: 00”
TravelDetails	`ReturnDate`	The last date of travel.	R	date/ti me	”2012-06- 07:00:00: 00”
TravelDetails	`RentalCarStartDate`	The first rental car date.	O	date/ti me	”2012-06- 02:10:00: 00”	Required if a rental car is purchased and the rental car start and end date are different from the departure and return date
TravelDetails	`RentalCarEndDate`	The last rental car date	O	date/ti me	”2012-06- 04:10:00: 00”	Required if a rental car is purchased and the rental car start and end date are different from the departure and return date
TravelDetails	Opt. (O)	Details
TravelDetails / Origin	`Code`	The airport code or other identifier for the location.	O	string	”LAX”	Strongly recommended that this is sent
TravelDetails / Origin	`Region`	The two digit state or province code.	O	string	”VA”	Strongly recommended that this is sent
TravelDetails / Origin	`Country`	The ISO country code for the location.	O	string	”US”	Strongly recommended that this is sent
TravelDetails / Destination	`Code`	The airport code or other identifier for the location.	O	string	”LAX”	Strongly recommended that this is sent
TravelDetails / Destination	`Region`	The abbreviation or code for state, province, or region.	O	string	”VA”	Strongly recommended that this is sent
TravelDetails / Destination	`Country`	The ISO country code for the location.	O	string	”US”	Strongly recommended that this is sent
TravelDetails / Providers / Provider	`Code`	Code for travel provider.	O	string	”test”
TravelDetails / Providers / Provider	`Name`	Name of travel provider.	O	string	”test”
TravelDetails	`TravelReason`	Reason for travel. i.e. ‘Business’ or ‘Leisure’	O	string	”Leisure”	Desired additional customer information
TravelDetails / FlightDetails / Flights / Flight	`FlightDate`	Date of the flight.	O	Date/ Time	”2012-06- 04:10:00: 00”
TravelDetails / FlightDetails / Flights / Flight	`Airline`	Two digit airline code	O	string	“DL”
TravelDetails / FlightDetails / Flights / Flight	Opt. (O)	Details
TravelDetails / FlightDetails / Flights / Flight	`FlightNumber`	Flight number	O	string	“2234”
TravelDetails / FlightDetails / Flights / Flight	`Airport`	Three character airport code.	O	string	“RIC”
ProductDetails / Product	`Sequence`	Unique sequence number for this purchase and product. First item in the sequence should be 0	R	int	”0”
ProductDetails / Product	`QuoteID`	The quote id is a value that is obtained from a quote response message from AWP that uniquely identifies a particular quote.	O	string	”123”	Optional but desired for tracking
ProductDetails / Product	`ProductID`	The identifier for the insurance product. It may be either the product name or code though use of the code is recommended	R	string	”Domestic Air Protector” or “0010011 22”
ProductDetails / Product / InsuredDetails / Insured	`InsuredSequence`	Unique sequence number for each individual who is purchasing this insurance product.	R	int	”0”	This controls both who is listed as the Primary and the order of the insureds. First item in the sequence should be the primary and the sequence number is 0
ProductDetails / Product / InsuredDetails / Insured	Opt. (O)	Details
ProductDetails / Product / InsuredDetails / Insured	`InsuredType`	The type of insured. Valid values include ‘PRIMARY’ or ‘OTHER’.	R	string	”PRIMARY “	There can be only one PRIMARY per purchase and it should be the first insured in the list
ProductDetails / Product / InsuredDetails / Insured	`FirstName`	The first name of the insured.	R	string	”Chris”
ProductDetails / Product / InsuredDetails / Insured	`MiddleInitial`	The middle initial of the insured.	O	string	”S”
ProductDetails / Product / InsuredDetails / Insured	`LastName`	The last name of the insured.	R	string	”Smith”
ProductDetails / Product / InsuredDetails / Insured	`Birthdate`	The date of birth of the insured. This is required if the insurance product is age-rated.	O	date	”1982-11- 05”	Required for age rated products and strongly recommended that it be sent even if the current product isn’t age rated
ProductDetails / Product / InsuredDetails / Insured	`Gender`	Gender of the insured.	O	enum	“Female”
ProductDetails / Product / InsuredDetails / Insured	`IPaddress`	IP address of the insured.	O	string	“199.116. 175.111”
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`Street`	The billing street address.	R	string	”9950 Mayland Dr”
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`Street2`	The billing street address - 2nd line.	O	string	”Ste 100”
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`City`	The billing city.	R	string	”Richmon d”
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`Region`	The two digit state or province code.	O	string	”VA”	Required for all US & CA Addresses
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`PostalCode`	The billing zip code or postal code.	R	string	”23233”
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	Opt. (O)	Details
ProductDetails / Product / InsuredDetails / Insured / InsuredAddress	`Country`	The billing ISO country code.	R	string	”USA”
ProductDetails / Product / InsuredDetails / Insured	`PhoneNumber`	The phone number of the PRIMARY insured	R	string	”8041234 567”	Required for primary insured only
ProductDetails / Product / InsuredDetails / Insured	`TripCost`	The individual trip cost for the insured.	O	double	”2500.00”	If this element is passed it supersedes that of TotalCoverageA mount
ProductDetails / Product / InsuredDetails / Insured	`Miles`	The airline miles used to book a ticket for the insured. This information is relevant if a reward type of travel insurance product is purchased.	O	int	”10000”
ProductDetails / Product / InsuredDetails / Insured	CustomerID (legacy item - no longer used)	The customer identifier, frequent flyer number, or membership number for this traveler.	N/A	string	”Identifier “	This is a legacy item and is no longer used
ProductDetails / Product / InsuredDetails / Insured	`Beneficiary`	The name of the beneficiary for this insured.	O	string	”Karl Schlebusc h”	Desired if the product purchased includes a death benefit
ProductDetails / Product / InsuredDetails / Insured	`NumberOfRooms`	Number of rooms being covered by the insurance policy.	O	int	“2”	Value should only be present if this is for hotel.
ProductDetails / Product / InsuredDetails / Insured / Memberships	`Name`	Name of the membership.	O	string	“Frequent Flyer”
ProductDetails / Product / InsuredDetails / Insured / Memberships	`Type`	Type of membership.	O	string	“Platinum ”
ProductDetails / Product / InsuredDetails / Insured / Memberships	`Number`	Number or account of the given membership.	O	string	“FF10983”
ProductDetails / Product / InsuredDetails / Insured / Memberships	Opt. (O)	Details
ProductDetails / Product	`CoverageAmount`	The trip cost to be covered by the insurance product.	R	double	”500.00”
ProductDetails / Product	`Price`	The price for the insurance product including premium and taxes	R	double	”27.50”
ProductDetails / Product	`PremiumPrice`	The premium amount for the insurance product.	O	double	”27.50”
ProductDetails / Product	`Taxes`	The tax amount for the insurance product.	O	double	”1.25”
ProductDetails / Product	CharitableContributi on	The charitable contribution amount for the insurance product.	O	double	”1.00”
ProductDetails / Product	`ProductBookingID`	The insurance product booking id or policy number.	O	string	”123456”	Required if partner is generating the policy number
Tuition	`FirstName`	First name of student.	O	string	“John”	Required for tuition.
Tuition	`LastName`	Last name of student.	O	string	“Dow”	Required for tuition.
Tuition	`DOB`	Student’s date of birth.	O	string	“1982-11- 05”	Required for tuition.
Tuition	`SchoolID`	School ID of the university	O	string	“25246”	Required for tuition.
Tuition	`YearsInSchool`	Number of years the student is in school.	O	date/ time	“3”	Required for tuition.
Tuition	Opt. (O)	Details
Tuition	`GPA`	GPA of the student.	O	double	“3.4”	Must be an integer, with up to two digits post decimil place: 2.25
Tuition	`StudyAbroad`	Is the student studying abroad?	O	boolean	“true”	Required for tuition.