Image RemovedImage Added

Insert excerpt

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

...

Excerpt

name	OrderChangeMetadata

PaymentFormMetadatas > ↔

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<OrderChangeMetadata / Other / OtherMetadata /

PaymentFormMetadatas> ↔ 3DS INFO (Add ancillaries and voluntary flight change flows…)

PaymentFormMetadata

Info

Attribute

PaymentFormMetadata@MetadataKeyMetadataKey

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

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

Alphanumeric

Any

IATA Schema if 'PaymentFormMetadatas' tag is indicated

PaymentFormMetadta / Text

Installments payment info

Alphanumeric

installments/n

where n=number of installments.

Valid example: installments/3Mandatory for installments payment

PaymentFormMetadata / AugmentationPoint / AugPoint

Info

Attribute

AugPoint@OwnerOwner

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

Alphabetical

IB

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

Backport_IberiaSecurePayment@xsixsi:schemaLocation

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

Alphanumeric

3-D Secure Payment

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

Backport_IberiaSecurePayment@xmlnsxmlns

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

Alphanumeric

3-D Secure PaymentIATA Schema if 'AugPoint ' tag is indicated

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Info

Attribute

Backport_IberiaSecurePayment@xmlnsxmlns:xsi

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

Alphanumeric

3-D Secure Payment

IATA Schema if 'AugPoint ' tag is indicated

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment / PaymentCardSecureInfo

Info

Attribute

PaymentCardSecureInfo@ObjectKeyObjectKey

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

Iberia NDC

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

The version of 3D-Secure supported.

Alphanumeric

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

1.0.2
2.1.0
2.2.0

IATA Schema if 'PaymentCardSecureInfo' tag is indicated

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

Contains the information that conveys 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

Iberia NDC 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 / 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 / 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

Iberia NDC for 3DS version 2.x.x

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

Alphabetical

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

OrderChangeMetadata example

Expand

title

...

Code Block

<OrderChangeMetadata>
	<Other>
		<OtherMetadata>
			<PaymentFormMetadatas>
				<PaymentFormMetadata MetadataKey="PAYMENT_FORM_METADATA">
					<AugmentationPoint>
						<AugPoint Owner="IB">
							<Backport_IberiaSecurePayment xsi:schemaLocation="http://www.iberia.com/IATA/NDC/SecurePayment/2017.2 Backport_IberiaSecurePayment_17.2.xsd" xmlns="http://www.iberia.com/IATA/NDC/SecurePayment/2017.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
								<PaymentCardSecureInfo ObjectKey="KEY_3DS">
									<PaymentFunctions>
										<PaymentMethodCriteria>
											<PaymentCardCriteria>
												<SecurePayerAuthenticationVersion>
													<CardEnrollmentVersionText>2.2</CardEnrollmentVersionText>
													<SupportedVersionText>2.2</SupportedVersionText>
												</SecurePayerAuthenticationVersion>
											</PaymentCardCriteria>
										</PaymentMethodCriteria>
										<PaymentProcessingDetails>
											<PaymentMethod>
												<PaymentCard>
													<SecurePaymentVersion2>
														<AuthenticationMerchantName/>
														<AuthenticationValue>##################</AuthenticationValue>
														<DirectoryServerTrxID>######################</DirectoryServerTrxID>
														<ElectronicCommerceInd>05</ElectronicCommerceInd>
														<ProgramProtocolText/>
														<TrxStatusReasonText/>
														<TrxStatusText>Y</TrxStatusText>
													</SecurePaymentVersion2>
													<SecureProgram>
														<EnrollmentStatusText>CardEnrolled</EnrollmentStatusText>
														<SecurePaymentProgramName>Verified by VISA</SecurePaymentProgramName>
													</SecureProgram>
													<SellerOwnCardInd>true</SellerOwnCardInd>
												</PaymentCard>
											</PaymentMethod>
										</PaymentProcessingDetails>
									</PaymentFunctions>
								</PaymentCardSecureInfo>
							</Backport_IberiaSecurePayment>
						</AugPoint>
					</AugmentationPoint>
				</PaymentFormMetadata>
			</PaymentFormMetadatas>
		</OtherMetadata>
	</Other>
</OrderChangeMetadata>

...

Versions Compared

Old Version 3

New Version Current

Key

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

OrderChangeMetadata example

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Attribute

Attribute

Attribute

Attribute

Attribute

Attribute

OrderChangeMetadata example