Skip Navigation

Query Payment Information

3.15.0
Air
Payment
SOAP API
Airline Carrier

v3.15.0 | February 1, 2022

  • In this version new functionality was introduced.
Read more

API Information

Format
XML
Current Version
3.15.0
Environment
Production

What's New

  • In this version new functionality was introduced.

New Features

In the Response

Optional

Parameter: QueryRQ002

Type: Element

Description: InstallmentRuleID is the ID for the specific rule

Sample Value:

<InstallmentOptions FOP_Type="CC" FOP_Code="AX" CardBIN="371593" CurrencyCode="USD" InstallmentRuleID="1234567"/>

v3.12.0 | February 7, 2020

  • HoursBeforeDeparture : new optional attribute added TripInfoType.
  • ValidatingCarrierCode : new attribute added to QueryRQ003.
  • TripInfo : new optional element added to QueryRQ003.
  • CountryCurrency : Removed under element in QueryRS003/FOP_Category/FOP_Detail
  • TripInfoType : Created the type for TripInfo as seperate element.
  • CountryCurrency : Added as new optional element in QueryRS003/CountryCurrency.
Read more

API Information

Format
XML
Current Version
3.12.0
Environment
Production

What's New

  • HoursBeforeDeparture : new optional attribute added TripInfoType.
  • ValidatingCarrierCode : new attribute added to QueryRQ003.
  • TripInfo : new optional element added to QueryRQ003.
  • CountryCurrency : Removed under element in QueryRS003/FOP_Category/FOP_Detail
  • TripInfoType : Created the type for TripInfo as seperate element.
  • CountryCurrency : Added as new optional element in QueryRS003/CountryCurrency.

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: HoursBeforeDeparture

Type: Integer

Description: HoursBeforeDeparture : new attribute added in QueryRQ002/TripInfo.

Sample Value:

|-|TripInfo TripType="D" OriginCity="SAO" OriginCountry="US" DestinationCity="SSZ" DestinationCountry="BR" HoursBeforeDeparture="0"|--|
    |-|/TripInfo|--|

In the Request

Optional

Parameter: ValidatingCarrierCode

Type: String

Description: A Validating Carrier Code is an arbitrary set of characters, often mnemonic in nature, that represents a private,public or government owned carrier that provide passenger transportation. Path would be : QueryRQ003/ValidatingCarrierCode

Sample Value:

|-|QueryRQ003 CountryCode="US" CurrencyCode="EUR" PaymentAmount="179.040" TransactionType="O" ProductType="A" ValidatingCarrierCode="LA"/|--|

In the Request

Optional

Parameter: TripInfo

Type: TripInfoType

Description: This type represents all the Trip Information

Sample Value:

|-|xs:complexType name="TripInfoType"|--|
        |-|xs:sequence|--|
            |-|xs:element name="FlightDetail" type="FlightDetailType" minOccurs="0" maxOccurs="20"/|--|
        |-|/xs:sequence|--|
        |-|xs:attribute name="TripType" type="xs:string" use="optional"|--|
            |-|xs:annotation|--|
                |-|xs:documentation|--|D - Domestic
I  - International|-|/xs:documentation|--|
            |-|/xs:annotation|--|
        |-|/xs:attribute|--|
        |-|xs:attribute name="OriginCity" type="xs:string" use="optional"/|--|
        |-|xs:attribute name="OriginCountry" type="xs:string" use="optional"/|--|
        |-|xs:attribute name="DestinationCity" type="xs:string" use="optional"/|--|
        |-|xs:attribute name="DestinationCountry" type="xs:string" use="optional"/|--|
        |-|xs:attribute name="HoursBeforeDeparture" type="xs:integer" use="optional"/|--|
    |-|/xs:complexType|--|

In the Response

Optional

Parameter: CountryCurrency

Type: CountryCurrencyType

Description: Added optional CountryCurrency as new element. Path would be : QueryRS003/CountryCurrency

Sample Value:

|-|PaymentQueryRS xmlns="http://services.sabre.com/PYMT/query/v01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2015-12-01T03:49:04" SabreTransactionID="12345447667970177080" Version="3.11.0" xsi:schemaLocation="http://services.sabre.com/PYMT/query/v01 PaymentQueryRQ_v3.11.0.xsd"|--|
   |-|Result ResultCode="SUCCESS" Description="Successful Transaction" /|--|
   |-|QueryRS003|--|
      |-|FOP_Category FOP_Type="CC"|--|
         |-|FOP_Detail FOP_RPH="1" FOP_Code="AX" FOP_SubCode="101" FOP_Description="American Express" RedirectPayment="true" RealtimePayment="true" PendingPayment="true"|--|
            |-|FOP_Detail FOP_Code="BT" FOP_Description="Travel Bank" RealtimePayment="true" MCPIneligible="true" /|--|
            |-|FOP_Issuers|--|
               |-|FOP_Issuer IssuerID="1121" IssuerName="Test Issuer" /|--|
            |-|/FOP_Issuers|--|
         |-|/FOP_Detail|--|
      |-|/FOP_Category|--|
      |-|CountryCurrency CountryCode="AR"|--|
         |-|Currencies CurrencyCode="ARS"/|--|
         |-|Currencies CurrencyCode="USD"/|--|
      |-|/CountryCurrency|--|
   |-|/QueryRS003|--|
|-|/PaymentQueryRS|--|

v3.11 | August 14, 2019

  • ValidatingCarrierCode : new attribute added to QueryRQ002
  • OrderType : new attribute added to QueryRQ002
  • QueryRQ006 : new service added
  • QueryRS006 : new service added
  • FopFeeAmount : new attribute added to QueryRS002
  • FopFeeTaxCode : new attribute added to QueryRS002
  • PromotionalInd : new attribute added to QueryRS002
  • FopFeeAmount : new attribute added to FullfilmentItemType
Read more

API Information

Format
XML
Current Version
3.11
Environment
Production

What's New

  • ValidatingCarrierCode : new attribute added to QueryRQ002
  • OrderType : new attribute added to QueryRQ002
  • QueryRQ006 : new service added
  • QueryRS006 : new service added
  • FopFeeAmount : new attribute added to QueryRS002
  • FopFeeTaxCode : new attribute added to QueryRS002
  • PromotionalInd : new attribute added to QueryRS002
  • FopFeeAmount : new attribute added to FullfilmentItemType

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: ValidatingCarrierCode

Type: string

Description: ValidatingCarrierCode is a new attribute added to QueryRQ002

Sample Value:

|-|QueryRQ002 FOP_Type="CC" FOP_Code="CA" CardBIN="542362" CurrencyCode="BRL" BaseAmount="150.00" TotalAmount="190.00" Taxes="40.00" Fees="0" CardIssuerCountry="BR" ProductType="1" ValidatingCarrierCode="AA" OrderType="O"|--|

In the Request

Optional

Parameter: OrderType

Type: string

Description: OrderType is a new attribute added to QueryRQ002

Sample Value:

|-|QueryRQ002 FOP_Type="CC" FOP_Code="CA" CardBIN="542362" CurrencyCode="BRL" BaseAmount="150.00" TotalAmount="190.00" Taxes="40.00" Fees="0" CardIssuerCountry="BR" ProductType="1" ValidatingCarrierCode="AA" OrderType="O"|--|

In the Response

Optional

Parameter: FopFeeAmount

Type: string

Description: FopFeeAmount is a new attribute added to QueryRS002

Sample Value:

|-|InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false"|--|

In the Response

Optional

Parameter: FopFeeTaxCode

Type: string

Description: FopFeeTaxCode is a new attribute added to QueryRS002

Sample Value:

|-|InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false"|--|

In the Response

Optional

Parameter: PromotionalInd

Type: boolean

Description: new attribute PromotionalInd added to QueryRS002/InstallmentOptions/InstallmentOption

Sample Value:

|-|InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false"|--|

In the Request/Response

Optional

Parameter: FopFeeAmount

Type: string

Description: New attribute FopFeeAmount added to FulfillmentItemType

Sample Value:

|-|FulfillmentItem ItemNbr="1" Type="TKT" Quantity="1" TotalAmount="990.02" BaseAmount="850.00" TaxAmount="0.00" FeeAmount="0.00" FopFeeAmount="950.00"/|--|

In the Request

Optional

Parameter: QueryRQ006

Type: mixed

Description: New service QueryRQ006 added

Sample Value:

|-|QueryRQ006 ValidatingCarrierCode="AA"|--|      |-|FOP_Details FOP_RPH="1" FOP_Type="CC" FOP_Code="AX" CurrencyCode="BRL" CardBIN="376446" PaymentAmount="603.83" /|--|      |-|FOP_Details FOP_RPH="2" FOP_Type="CC" FOP_Code="VI" CurrencyCode="BRL" CardBIN="444433" PaymentAmount="1000.00" /|--|      |-|FulfillmentDetails FulfillmentTotalAmount="1603.83" FulfillmentTaxAmount="173.93" FulfillmentFeeAmount="0.00" FulfillmentBaseAmount="1429.90"|--|         |-|PsgrFulfillmentItems NameNumberInPNR="1.1" LastName="LASTNAME" FirstName="FIRSTNAME"|--|            |-|FulfillmentItem Type="TKT" TotalAmount="603.83" TaxAmount="73.93" Quantity="1" ItemNbr="1" BaseAmount="529.90"|--|               |-|TaxBreak|--|                  |-|Tax TaxCode="BR" TaxAmount="30.94" /|--|                  |-|Tax TaxCode="DU" TaxAmount="42.99" /|--|               |-|/TaxBreak|--|            |-|/FulfillmentItem|--|         |-|/PsgrFulfillmentItems|--|         |-|PsgrFulfillmentItems NameNumberInPNR="1.2" LastName="LASTNAMETWO" FirstName="FIRSTNAMETWO"|--|            |-|FulfillmentItem Type="AE" TotalAmount="1000.00" TaxAmount="100.00" Quantity="1" ItemNbr="1" BaseAmount="900.00"|--|               |-|TaxBreak|--|                  |-|Tax TaxCode="BR" TaxAmount="50.00" /|--|                  |-|Tax TaxCode="DU" TaxAmount="50.00" /|--|               |-|/TaxBreak|--|            |-|/FulfillmentItem|--|         |-|/PsgrFulfillmentItems|--|      |-|/FulfillmentDetails|--|   |-|/QueryRQ006|--|

In the Response

Optional

Parameter: QueryRS006

Type: mixed

Description: new service QueryRS006 added.

Sample Value:

|-|QueryRS006|--|      |-|FOP_Details FOP_RPH="1" FOP_Type="CC" FOP_Code="AX" CardBIN="376446" CurrencyCode="BRL" PaymentAmount="603.83" FopFeeAmount="3.41" FopFeeTaxCode="OB" /|--|      |-|FOP_Details FOP_RPH="2" FOP_Type="CC" FOP_Code="VI" CardBIN="444433" CurrencyCode="BRL" PaymentAmount="1000.00" FopFeeAmount="5.65" FopFeeTaxCode="OB" /|--|      |-|FulfillmentDetails FulfillmentTotalAmount="1603.83" FulfillmentBaseAmount="1429.90" FulfillmentTaxAmount="173.93" FulfillmentFeeAmount="0.00"|--|         |-|PsgrFulfillmentItems NameNumberInPNR="1.1" FirstName="FIRSTNAME1" LastName="LASTNAME1"|--|            |-|FulfillmentItem ItemNbr="1" Type="TKT" Quantity="1" TotalAmount="603.83" BaseAmount="529.90" FeeAmount="22.24" TaxAmount="73.93" InterestAmount="2.21" FopFeeAmount="9.06"|--|               |-|TaxBreak|--|                  |-|Tax TaxCode="BR" TaxAmount="30.94" /|--|                  |-|Tax TaxCode="DU" TaxAmount="42.99" /|--|               |-|/TaxBreak|--|            |-|/FulfillmentItem|--|         |-|/PsgrFulfillmentItems|--|         |-|PsgrFulfillmentItems NameNumberInPNR="1.2" FirstName="FIRSTNAME2" LastName="LASTNAME2"|--|            |-|FulfillmentItem ItemNbr="1" Type="AE" Quantity="1" TotalAmount="1000.00" BaseAmount="900.00" FeeAmount="12.54" TaxAmount="100.00" InterestAmount="7.32" |--|               |-|TaxBreak|--|                   |-|Tax TaxCode="BR" TaxAmount="50.00" /|--|                  |-|Tax TaxCode="DU" TaxAmount="50.00" /|--|               |-|/TaxBreak|--|            |-|/FulfillmentItem|--|         |-|/PsgrFulfillmentItems|--|      |-|/FulfillmentDetails|--|   |-|/QueryRS006|--|

v3.9.0 | December 12, 2018

  • Elements updated for Form of payment and added for Form of payment response
  • Attributes added for form of payment validation result
Read more

API Information

Format
XML
Current Version
3.9.0
Environment
Production

What's New

  • Elements updated for Form of payment and added for Form of payment response
  • Attributes added for form of payment validation result

Business Value

  • New fields added to the schema

v3.8.0 | June 20, 2018

  • New attribute for installment plan and a new element for custom fields added to schema
Read more

API Information

Format
XML
Current Version
3.8.0
Environment
Production

What's New

  • New attribute for installment plan and a new element for custom fields added to schema

Business Value

  • New fields added to the schema

New Features

In the Response

Optional

Parameter: Plan

Type: String

Description: New optional attribute "Plan" of type String added to QueryRS002/InstallmentOptions/InstallmentOption/@Plan. This is for the installment plan id.

Sample Value:

|-|PaymentQueryRS SystemDateTime="2016-05-16T00:00:00" SabreTransactionID="05111463374800012001" Version="3.8.0" xmlns="http://services.sabre.com/PYMT/query/v01"|--|   |-|Result ResultCode="SUCCESS" Description="Successful Transaction"/|--|    |-|QueryRS002|--|        |-|InstallmentOptions FOP_Type="CC" FOP_Code="IK" CardBIN="522999" CurrencyCode="BRL"|--|            |-|InstallmentOption Plan="PlanZ" NbrOfInstallments="9" TotalPaymentAmount="4716.82" InstallmentAmount="352.98" InterestAmount="216.82" InterestRate="9.5"|--|                |-|OtherPayments TotalAmount="1540.00"|--|                    |-|TaxBreak|--|                        |-|Tax TaxCode="BR" TaxAmount="1540.00"/|--|                    |-|/TaxBreak|--|                |-|/OtherPayments|--|                |-|FulfillmentDetails FulfillmentTotalAmount="4500.00"|--|                    |-|PsgrFulfillmentItems NameNumberInPNR="1.1" FirstName="PAX1FName1" LastName="PAX1LName1"|--|                        |-|FulfillmentItem ItemNbr="1" Type="TKT" Quantity="1" TotalAmount="990.02" BaseAmount="850.00" InterestAmount="47.70"/|--|                                           |-|/PsgrFulfillmentItems|--|                                   |-|/FulfillmentDetails|--|            |-|/InstallmentOption|--|                               |-|/InstallmentOptions|--|    |-|/QueryRS002|--||-|/PaymentQueryRS|--|

In the Response

Optional

Parameter: FOP_CustomFields

Type: Custom type

Description: New optional element FOP_CustomFields added to QueryRS003/FOP_Category/FOP_Detail/FOP_CustomFields

Sample Value:

|-|PaymentQueryRS xmlns="http://services.sabre.com/PYMT/query/v01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2015-12-01T03:49:04" SabreTransactionID="12345447667970177080" Version="3.8.0" xsi:schemaLocation="http://services.sabre.com/PYMT/query/v01 PaymentQueryRQ_v3.8.0.xsd"|--| |-|Result ResultCode="SUCCESS" Description="Successful Transaction"/|--|    |-|QueryRS003|--|       |-|FOP_Category FOP_Type="CC"|--|           |-|FOP_Detail FOP_RPH="1" FOP_Code="AX" FOP_SubCode="101" FOP_Description="American Express" RedirectPayment="true" RealtimePayment="true" PendingPayment="true"|--|            |-|FOP_Detail FOP_Code="BT" FOP_Description="Travel Bank" RealtimePayment="true" MCPIneligible="true"/|--|              |-|FOP_Issuers|--|                  |-|FOP_Issuer IssuerID="1121" IssuerName="Test Issuer" /|--|                |-|/FOP_Issuers|--|             |-|FOP_CustomFields|--|                    |-|CustomFieldConfig Name="EMAILADDRESS" Label="Email Address" DisplayType="TEXTBOX" MandatoryInd="false" SequenceNbr="1" MinLength="5" MaxLength="50" DataType="String"                        RegexValidationExpr="^([a-zA-Z0-9_\-\.] )@([a-zA-Z0-9_\-\.] )\.([a-zA-Z]{2,5})$" POSFieldKeyword="EMAILADDRESS"/|--|                    |-|CustomFieldConfig Name="MobPhoneCountryCode" Label="Phone Country Code" DisplayType="DROPDOWN" MandatoryInd="true" SequenceNbr="2" MinLength="3" MaxLength="3" DataType="String"                        DropDownValue="Phone Country Code" RegexValidationExpr="\d{3}" POSFieldKeyword="MobPhoneCountryCode"/|--|                |-|/FOP_CustomFields|--|                         |-|/FOP_Detail|--|      |-|/FOP_Category|--|    |-|/QueryRS003|--||-|/PaymentQueryRS|--|

v3.6.0 | June 14, 2017

  • New attribute OfficeCode added to POS_Type
Read more

API Information

Format
XML
Current Version
3.6.0
Environment
Production

What's New

  • New attribute OfficeCode added to POS_Type

New Features

In the Request

Optional

Parameter: OfficeCode

Type: String

Description: Office code is 2-letter office code/2-letter account code of office designator/office account code which allows airlines to be able to differentiate between the business role and functionality performed at each one.

Sample Value:

|-|POS StationNumber="23496605" ISOCountry="DE" CityCode="AUH" PseudoCityCode="AUH" ChannelID="WEB" SourceID="SSW" LocalDateTime="2001-12-17T09:30:47Z" OfficeCode="OF"|--|