Skip to main content

Auto Exchange And Refund

1.5.6
Air
Pricing
SOAP API
Airline Carrier

API Information

Response Format
XML
Service Action Code
AERRQ
Current Version
1.5.6
Target Audience
AS
Environment
Production

What's New

Business Value

  • You can now suppress the mileages values filed as monetary values during exchanges and full/partial refunds in AERRQ. These values will be returned in the response as well.

New Features

In the Request/Response

Optional

Parameter: award

Type: boolean

Description: AERRQ now supports an "award" qualifier that suppresses mileage values filed as monetary values during Exchange and Refund transactions, specifically for Frequent Flyer Passenger Types.

Sample Value:

award="true"
Note: "award" should be set to "true" to suppress the mileage value that is filed as a monetary value for Frequent Flyer Passenger Types. Omission assumes "false".

Relase note ID: 16313


API Information

Response Format
XML
Service Action Code
AERRQ
Current Version
1.5.5
Target Audience
AS
Environment
Production

What's New

Business Value

  • The capability to collect or refund commission during additional collection exchanges and full/partial refunds respectively in AERRQ and return the values in response as well.

New Features

In the Request/Response

Optional

Parameter: Commission

Type: Element

Description: Commission type can be specified in the RQ as Percentage or Amount

Sample Value:

 
Note: Commission can be collected/refunded during Add collect exchange or Full or Partial refund respectively by an agent.

Relase note ID: 15852


  • Support for Brand Attributes in the Web Service Response.
  • Support for Account Codes in the |-|Passenger|--| element.

API Information

Response Format
XML
Service Action Code
AERRQ
Current Version
1.5.4
Target Audience
AS
Environment
Production

What's New

  • Support for Brand Attributes in the Web Service Response.
  • Support for Account Codes in the |-|Passenger|--| element.

Business Value

  • The ability to return 4 brand attributes in the RS when a brand code was used in the RQ.
  • The inclusion of an account code included in the RQ with the XC pricing qualifier.

New Features

In the Request/Response

Optional

Parameter: Brand Code

Type: string

Description: Brand codes are used with Branded Fares, the RS schema will now return 4 brand attributes: Brand Code, Brand Description, Program Code, Program Description

Sample Value:

Sample Brand Code = YC, sample Brand Description = ECONOMY STANDARD, sample Program Code = QES, sample Program Description = QES2018
Note:

In the Request/Response

Optional

Parameter: account code

Type: string

Description: The updated AERRQ now allows the use of an account code with the XC qualifer

Sample Value:

account code = ALL25
Note:

Relase note ID: 12893


  • The Automated Exchange and Refund web service (AERRQ) has been modified to provide a reason code in the event that the Change Fee or Other fee was manually manipulated by an airline agent.

API Information

Response Format
XML
Service Action Code
AERRQ
Current Version
1.5.3
Target Audience
AS
Environment
Production

What's New

  • The Automated Exchange and Refund web service (AERRQ) has been modified to provide a reason code in the event that the Change Fee or Other fee was manually manipulated by an airline agent.

Business Value

  • Provides airlines a more effective way to trace fraud and amounts being overridden by agents via the Automated Exchange and Refund product. •Required to correctly track fraud and the amounts being overridden. •Waiver table is necessary to provide airlines with the capability to waive restrictions and fees due to extraordinary events.

New Features

In the Request/Response

Optional

Parameter: waiverCode

Type: string

Description: Identifies the wavier code which is populated from the MISCO table, and the source of the waiver which can be ATSE or AGENT

Sample Value:

waiverCode //element(*,Fare.AER)/Fees/@waiverCode waiverSource //element(*,Fare.AER)/Fees/@waiverCode
Note:

Relase note ID: 12988


  • AER WS schema version 1.5.2 AER WS enables an exchange resulting in a residual value to be Refunded to EMD-S. This new feature allows airline agents to refund the the complete amount to an EMD-S, and also add endorsement text of 147 characters to EMD-S.

API Information

Response Format
XML
Service Action Code
AERRQ
Current Version
1.5.2
Target Audience
AS
Environment
Production

What's New

  • AER WS schema version 1.5.2 AER WS enables an exchange resulting in a residual value to be Refunded to EMD-S. This new feature allows airline agents to refund the the complete amount to an EMD-S, and also add endorsement text of 147 characters to EMD-S.

Business Value

  • Adds efficiency and streamline the Auto Exchange and Refund process by eliminating the need for an agent to manually create a document representing the residual amount of an exchange. This feature allows the agent to automatically issue an Electronic Miscellaneous Document (Standalone / EMD-S) so that the ticket exchange and residual amount is part of a single process.

New Features

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

 
Note:

Functional Updates And Enhancements

In the Request

Optional

Parameter: refundIndex

Type: string

Description: Added optional attribute AER_RQ/AERDetails/Message/@refundIndex to be populated in case of EMD-S document as Endorsement Message Index Added type 'L' to optional attribute AER_RQ/AERDetails/Message/@Type to represent Stand-alone EMD endorsement for refund User has to provide value “StandAloneEMD” in Refund “type” to refund the residual amount to EMD-S

Sample Value:

 
Note: User has to provide value “StandAloneEMD” in Refund “type” to refund the residual amount to EMD-S

In the Request

Optional

Parameter: Type

Type: string

Description: Added type 'L' to optional attribute AER_RQ/AERDetails/Message/@Type to represent Stand-alone EMD endorsement for refund

Sample Value:

 
Note: User has to provide value “StandAloneEMD” in Refund “type” to refund the residual amount to EMD-S

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

 
Note:

Relase note ID: 13032