Insert excerpt

	API Messages with Examples
	API Messages with Examples
name	Legend
nopanel	true

Currency

Excerpt

name	CurrencyMetadata

<Response / Metadata / Other / OtherMetadata / CurrencyMetadatas>

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

CurrencyMetadatas / CurrencyMetadata

Info

Attribute

MetadataKey

ID of the Metadata using the currency code

Alphanumeric

Any available currency for the defined market

All Services

CurrencyMetadata / Decimals

Number of decimals for the currency

Numeric

Any

All Services

CurrencyMetadata / Name

The name of the currency

Alphabetical

Any

All Services

Expand

title	Example

Code Block

language	xml

<CurrencyMetadatas>
  <CurrencyMetadata MetadataKey="USD">
      <Decimals>2</Decimals>
      <Name>DÛlar (USA)</Name>
  </CurrencyMetadata>
</CurrencyMetadatas>

Fare Rules

Excerpt

name	RuleMetadatas

<Response / Metadata / Other / OtherMetadata / RuleMetadatas>

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

RuleMetadata

Info

Attribute

MetadataKey

ID of the Metadata

Alphanumeric

Any

All Services

RuleMetadata / RuleID

ID of the Metadata

Alphanumeric

Cancel
Change

All Services

RuleMetadata / RuleID / Values / Value / Instruction

This indicator will displayed the following options:

"Allowed" → This fare will be refundable or changeable
"Not Allowed" → This fare will not be refundable or changeable

Alphabetical

Allowed
Not Allowed

All Services

Expand

title	Example

Code Block

language	xml

<OtherMetadata>
	<RuleMetadatas>
		<RuleMetadata MetadataKey="RULEMETADATAKEY_2">
			<RuleID>Cancel</RuleID>
			<Values>
				<Value>
					<Instruction>Not Allowed</Instruction>
				</Value>
			</Values>
		</RuleMetadata>
		<RuleMetadata MetadataKey="RULEMETADATAKEY_3">
			<RuleID>Change</RuleID>
			<Values>
				<Value>
					<Instruction>Allowed</Instruction>
				</Value>
			</Values>
		</RuleMetadata>
	</RuleMetadatas>
</OtherMetadata>

Forms of Payment

Excerpt

name	PaymentFormMetadata

<Response / Metadata / Other / OtherMetadata / PaymentFormMetadatas>

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

PaymentFormMetadata

Info

Attribute

refs

Reference from<PaymentCard ObjectKey>

Alphanumeric

Any

OfferPriceRS

PaymentFormMetadata

Info

Attribute

MetadataKey

For 3DS info, this key is mandatory and can be filled in with any value.

For installments payment info, this key needs to match with installments reference in PaymentCard Refs.

Alphanumeric

Any

OfferPriceRS

OrderCreate & OrderChange for payment in installments

PaymentFormMetadata / Text

Installments payment info.

Number of installments and interest rate applied by card issuer.

Examples:

<Text>installments/1/0.00</Text>

<Text>installments/3/1.23</Text>

<Text>installments/9/variable</Text>

Alphanumeric

installments/n/X.XX

where n=number of installments.

where X.XX=interests rate in %

Valid example: installments/3/0.00

OfferPriceRS

OrderCreate & OrderChange for payment in installments

PaymentFormMetadata / AugmentationPoint / AugPoint

Info

Attribute

Owner

Airline code associated to 3DS Payment, in this case IB.

Alphabetical

IB

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

xsi:schemaLocation

Reference to IATA 3DS new schema info xsd for Secure Payment.

Alphanumeric

3-D Secure Payment

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

xmlns

Reference to IATA 3DS new schema info for Secure Payment.

Alphanumeric

3-D Secure Payment

Mandatory if 'AugPoint ' tag is indicated

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

xmlns:xsi

Reference to IATA 3DS new schema info for Secure Payment.

Alphanumeric

3-D Secure Payment

Mandatory if 'AugPoint ' tag is indicated

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo

Info

Attribute

ObjectKey

This Attribute is used to reference the applicable PaymentCard in the Payments section of this message.

Alphanumeric

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentMethodCriteria / PaymentCardCriteria / SecurePayerAuthenticationVersion / CardEnrollmentVersionText

The version of 3D-Secure for which the card is enrolled.

Alphanumeric

This field must contain the specific 3DS version used for authentication:

1.0.2
2.1.0
2.2.0

NDC Mandatory

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentMethodCriteria / PaymentCardCriteria / SecurePayerAuthenticationVersion / SupportedVersionText

Version of 3D-Secure supported. This tag is mandatory for schema.

Alphanumeric

This field must contain the specific 3DS version used for authentication:

1.0.2
2.1.0
2.2.0

Mandatory if 'PaymentCardSecureInfo' tag is indicated

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion1 / PayerAuthenticationResponseText

Contains the indicators and fields that convey the result of the 3D Secure authentication transaction. Applicable for 3D Secure Version 1.x.x This tag is NDC mandatory for version 1.x.x and if is not included, an error will be returned.

This field is the authentication response for the 3-D Secure transaction. It is used to determine whether or not the customer has been authenticated by the card issuer. It must be included in the final authorization request. Example: eJzVWFmzosgSfudXdPQ8Gt1sbkzYRhQ7KCjI/sYOsimgoL/+lp7Tp5c5t2d67tMw8yv/WqiluJXS8WyyVFEQT28qz

Alphanumeric

Any

NDC Mandatory for 3DS version 1.x.x

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / AuthenticationMerchantName

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to name of the merchant assigned by the Acquirer or Payment System.

Alphanumeric

Maximum → 40 characters

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / AuthenticationTokenValue

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to authentication value of a token.

Alphanumeric

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / AuthenticationValue

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to 3DS authentication value returned. It is a cryptographic value generated by the ACS to provide a way, during authorisation processing, for the authorisation system to validate the integrity of the authentication result. The AV algorithm is defined by each Payment System.

Alphanumeric

Maximum → 28 characters

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / CardNumberCollectionCode

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field indicates the collection method of the card number.

Alphanumeric

K
S

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / DirectoryServerTrxID

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to DS (Directory Server) transaction ID returned. Universally unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

Alphanumeric

Maximum → 36 characters

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / ElectronicCommerceInd

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to 3DS ECI (electronic commerce indicator). Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder.

This tag is NDC mandatory for version 2.x.x and if is not included, an error will be returned.

Some ECI values and the meaning of this is the following:

01 → Authentication could not be completed but a proof of authentication attempt was provided SLI = 1 → MasterCard
02 → Cardholder was successfully authenticated (SLI = 2) → MasterCard
05 → This value means that the cardholder was authenticated by the issuer by verifying the cardholder’s password or identity information. The value is returned by the ACS in the Payer Authentication Response message when the cardholder successfully passed 3-D Secure payment authentication → Visa
06 → This value means that the merchant attempted to authenticate the cardholder, but either the cardholder or issuer was not participating. The value should be returned by the ACS in the Authentication Response message for an Attempt Response. Additionally, merchants may use an ECI 6 in the authorization request when a Verify Enrollment of N is received from the Visa Directory Server → Visa
07 → This value is set by the merchant when the payment transaction was conducted over a secure channel (for example, SSL/TLS), but payment authentication was not performed, or when the issuer responded that authentication could not be performed. An ECI 7 applies when either the Verify Enrollment or the Payer Authentication Response contains a U for Unable to Authenticate → Visa

Numeric

Two characters

Any

NDC Mandatory for 3DS version 2.x.x

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / PayerAuthenticationExemptionCode

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is used to identify an exemption to performing payer authentication.

Alphanumeric

AO
DA
LV
MA
ND
SC
TB
TR

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / PayerAuthenticationFailureToCompleteCode

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is used to identify possible pre defined reasons for failure to complete payer authentication.

Alphanumeric

NC
NS

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / PaymentTrxChannelCode

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field indicates the payment transaction channel.

Alphanumeric

EC
FA
MO
NS
TO

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / ProgramProtocolText

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field is related to Program Protocol.

Alphanumeric

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / TrxStatusReasonText

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field provides information on why the Transaction Status field has the specified value

Alphanumeric

Two characters

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecurePaymentVersion2 / TrxStatusText

Contains all information for the result of 3D-Secure authentication process. Applicable for 3D Secure Version 2.x.x

This field indicates whether a transaction qualifies as an authenticated transaction or account verification.

Alphabetic

One character

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecureProgram / EnrollmentStatusText

Contains all information for the result of 3D-Secure authentication process. Applicable for 3DS.

3D Secure Program Enrollment Status. Examples → CardNotEnrolled, CardEnrolled, CardMayBeEnrolled, Unknown

Alphabetic

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SecureProgram / SecurePaymentProgramName

Contains all information for the result of 3D-Secure authentication process. Applicable for 3DS.

Name of the secure payment program. Example → Verified by Visa.

Alphanumeric

Any

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo / PaymentFunctions / PaymentProcessingDetails / PaymentMethod / PaymentCard / SellerOwnCardInd

Contains all information for the result of 3D-Secure authentication process. Applicable for 3DS.

When TRUE, indicates the seller is using their own card. If FALSE, customer card is being used.

Boolean

true/false

Expand

title	Example

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="PayMeta1 PayMeta2 PayMeta3 PayMeta4 PayMeta5 PayMeta6 PayMeta7 PayMeta8 PayMeta9 PayMeta10" ObjectKey="PaymentCard1">
				<CardType>VI</CardType>
			</PaymentCard>
		</Method>
		<Amount>0</Amount>
	</Payment>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="PayMeta11 PayMeta12 PayMeta13 PayMeta14 PayMeta15 PayMeta16 PayMeta17 PayMeta18 PayMeta19 PayMeta20" ObjectKey="PaymentCard2">
				<CardType>AX</CardType>
			</PaymentCard>
		</Method>
		<Amount>0</Amount>
	</Payment>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="PayMeta21 PayMeta22 PayMeta23 PayMeta24 PayMeta25 PayMeta26 PayMeta27 PayMeta28 PayMeta29 PayMeta30" ObjectKey="PaymentCard3">
				<CardType>EL</CardType>
			</PaymentCard>
		</Method>
		<Amount>0</Amount>
	</Payment>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="PayMeta31 PayMeta32 PayMeta33 PayMeta34 PayMeta35 PayMeta36 PayMeta37 PayMeta38 PayMeta39 PayMeta40" ObjectKey="PaymentCard4">
				<CardType>TP</CardType>
			</PaymentCard>
		</Method>
		<Amount>0</Amount>
	</Payment>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="PayMeta41 PayMeta42 PayMeta43 PayMeta44 PayMeta45 PayMeta46 PayMeta47 PayMeta48 PayMeta49 PayMeta50" ObjectKey="PaymentCard5">
				<CardType>CA</CardType>
			</PaymentCard>
		</Method>
		<Amount>0</Amount>
	</Payment>
	<Payment>
		<Type>MS</Type>
		<Method>
			<Voucher/>
		</Method>
		<Amount>0</Amount>
	</Payment>
</Payments>
...
<OtherMetadata>
	<PaymentFormMetadatas>
		<PaymentFormMetadata refs="PaymentCard1" MetadataKey="PayMeta1">
			<Text>installments/1/0.00</Text>
		</PaymentFormMetadata>
		<PaymentFormMetadata refs="PaymentCard1" MetadataKey="PayMeta2">
			<Text>installments/2/0.00</Text>
		</PaymentFormMetadata>
		<PaymentFormMetadata refs="PaymentCard1" MetadataKey="PayMeta3">
			<Text>installments/3/0.00</Text>
		</PaymentFormMetadata>
		<PaymentFormMetadata refs="PaymentCard1" MetadataKey="PayMeta4">
			<Text>installments/4/0.00</Text>
		</PaymentFormMetadata>
		<...>
	</PaymentFormMetadatas>
</OtherMetadata>

PricedMetadata

Excerpt

name	PricedMetadata

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

Other / OtherMetadata / PriceMetadatas

Info

Attribute

PricedMetadata@MetadataKey

Type of price

Alphabetical

Presently the only accepted value is:

“IncludeUpsellOffers”

Mandatory for schema if 'Metadata' tag is indicated

...

Versions Compared

Old Version 6

New Version Current

Key

Currency

Attribute

Fare Rules

Attribute

Forms of Payment

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

PricedMetadata

Attribute

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Currency

Attribute

Fare Rules

Attribute

Forms of Payment

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

PricedMetadata

Attribute