Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
nameQuery_Payments

Query - Payments

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Payments / Payment> (Add ancillaries and voluntary flight change flows…)

Type

Payment Methods can vary depending on market and type of seller.

Please check here.

Alphabetical

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

  • SF (Service Fee)

--  This refers to Cash payment method  --

Method / Cash

Info

Attribute

CashInd

Cash payment method.

Alphabetical

true

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

In Cash Payment Method is OPTIONAL

Alphanumeric

Any valid reference associated in the XML below.

--  This refers to Credit Card method  – If Secure Payment applies additional info needed is defined below in 3DS INFO --

Method / PaymentCard

Info

Attribute

refs

NDC Mandatory for 3DS and/or installments payment.

This is used to reference the associated 3DS info in PaymentCardSecureInfo ObjectKey, and/or the installment payment info in PaymentFormMetadata MetadataKey.

If both 3DS and installment payments are being used for the same Order, then the two references are included here together separated by a space.

Example:

Code Block
languagexml
<PaymentCard refs="KEY_3DS KEY_QUOTAS">

Alphanumeric

Any

Method / PaymentCard / CardType 

Type of credit card

Alphanumeric

1-6 characters

Method / PaymentCard / SeriesCode

Series Code of credit card

Numeric

1-8 characters

Method / PaymentCard / CardHolderName

Card Holder Name

Alphanumeric

0-50 characters

Method / PaymentCard / CardHolderBillingAddress / Street

Street of the billing address of the cardholder.

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

If tag is indicated once, only first 40 characters will be considered

If tag is indicated twice, only first 80 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / CityName

City of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

Only first 50 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / StateProv

State Prov. of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

1-40 characters

Method / PaymentCard / CardHolderBillingAddress / PostalCode

Postal Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

2-10 characters

Method / PaymentCard / CardHolderBillingAddress / CountryCode

Country Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphabetical

2 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-9 characters

Method / PaymentCard / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 characters

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

--  This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

Alphabetical

true

Method / Voucher / Number 

Number of the voucher

Alphanumeric

any

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

OrderChangeRQ Query Payments examples

...

titleQuery Cash Payment example

...

languagexml

...

-- This refers to Service Fee method --

Method / Other / Remarks

Info

Attribute

refs

References for all passengers of the order

Alphanumeric

any

Method / Other / Remarks / Remark

Service Fee payment method

Mandatory for schema if "Remarks" tag is indicated

Alphabetical

ServiceFee

Amount

Info

Attribute

Code

Total amount of the Service Fee

Code refers to currency code for payment.

Numeric

Any

OrderChangeRQ Query Payments examples

Expand
titleQuery Cash Payment example
Code Block
languagexml
<Payments>
    <Payment>
      <Type>CA</Type>
      <Method>
          <Cash CashInd="true"/>
      </Method>
      <Amount Code="EUR">10.00</Amount>
      <Payer>
          <ContactInfoRefs>Payer</ContactInfoRefs>
      </Payer>
    </Payment>
</Payments>
Expand
titleQuery Credit Card Payment example
Code Block
languagexml
<Payments>
    <Payment>
      <Type>CA<<Type>CC</Type>
      <Method>
          <Cash<PaymentCard CashIndrefs="true"/>KEY_QUOTAS">
            <CardType>VI</CardType>
            <<SeriesCode>XXX</Method>SeriesCode>
      <Amount Code="EUR">10.00</Amount>     <CardHolderName>JANE SMITH</CardHolderName>
<Payer>           <ContactInfoRefs>Payer</ContactInfoRefs> <CardHolderBillingAddress>
     </Payer>     </Payment> </Payments>
Expand
titleQuery Credit Card Payment example
Code Block
languagexml
<Payments>     <Payment><Street>125 PRESTON RD  BRIGH</Street>
  <Type>CC</Type>       <Method>       <CityName>MA</CityName>
   <PaymentCard refs="KEY_QUOTAS">             <CardType>VI<<StateProv>BN</CardType>StateProv>
            <SeriesCode>XXX</SeriesCode>    <PostalCode>BN12LP</PostalCode>
        <CardHolderName>JANE SMITH</CardHolderName>       <CountryCode>PE</CountryCode>
     <CardHolderBillingAddress>       </CardHolderBillingAddress>
         <Street>125 PRESTON RD BRIGH<<CardNumber>44XXXXXXXXXXXX04</Street>CardNumber>
            <EffectiveExpireDate>
   <CityName>MA</CityName>               <Expiration>MMYY</Expiration>
 <StateProv>BN</StateProv>           </EffectiveExpireDate>
     <PostalCode>BN12LP</PostalCode>     </PaymentCard>
      </Method>
    <CountryCode>PE</CountryCode>  <Amount Code="USD">119.80</Amount>
      <Payer>
  </CardHolderBillingAddress>        <ContactInfoRefs>Payer</ContactInfoRefs>
    <CardNumber>44XXXXXXXXXXXX04</CardNumber>  </Payer>
    </Payment>
</Payments>
Expand
titleQuery Voucher Payment example
Code Block
languagexml
<Payments>
	<Payment>
		<Type>MS</Type>
		<Method>
 <EffectiveExpireDate>
                <Expiration>MMYY</Expiration>
  			<Voucher>
				<Number>BONO100EUR</Number>
			</Voucher>
		</Method>
		<Amount Code="EUR">339.67</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleQuery Service Fee Payment example
Code Block
languagexml
<Payments>
  <Payment>
      <Type>SF</Type>
  </EffectiveExpireDate>    <Method>
      </PaymentCard>  <Other>
    </Method>        <Amount<Remarks Coderefs="USD">119.80</Amount>ADULT_01">
      <Payer>        <Remark>ServiceFee</Remark>
  <ContactInfoRefs>Payer</ContactInfoRefs>       </Payer>   </Remarks>
 </Payment> </Payments>
Expand
titleQuery Voucher Payment example
Code Block
languagexml
<Payments> 	<Payment> 		<Type>MS</Type> 		<Method> 			<Voucher> 				<Number>BONO100EUR</Number> 			</Voucher>
		Other>
      </Method>
		      <Amount Code="EUR">339>11.67<00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs> 		</Payer> 	</Payment>
</Payments>