Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Release 2023.15

Legend

New or modified field

Field to be removed/deprecated

HTTP Headers

HEADER NAME

DESCRIPTION

MANDATORY?

EXAMPLE

api_key

Your unique key used to authorize access to the API.

Yes

n/a

Request Body

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers. If PrimaryLangID is not avalaible for the service, it will use default language

2 Alphabetic

Depends of the Country code

Version

The IATA version of the message

Numeric

Any

Schema

<PointOfSale>

Location / CountryCode

Country code. It will be obtained by NDC_SELLERS table.

2 Alphabetical

List of Countries

<Document>

Schema

ReferenceVersion

The IATA Schema version.

Numeric

Any

<Party / Sender> Only for Real IATA

Schema

TravelAgencySender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric

7/8 Numbers

NDC Mandatory

<Party / Sender> Only for Pseudo IATA

Schema

TravelAgencySender / OtherIDs / OtherID

Pseudo IATA (assigned by Iberia)

Numeric

7/8 Numbers

NDC Mandatory

<Party>

Schema

Sender / TravelAgencySender / Name

Agency Name. It will be obtained by NDC_SELLERS table.

Alphanumeric

Any

Sender / TravelAgencySender / Contacts / Contact

Attribute

ContactType

Field that agencies can inlclude to specify the information to include in confirmation mails.

  • itin_only

  • itin_and_price (default value)

Alphabetical

  • itin_only

  • itin_and_price (default value)

Mandatory for schema if "ContactType" attribute is indicated.

Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address

Email to contact the Agency

Alphanumeric

Any

Mandatory for schema if 'EmailContact' tag is indicated.

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application

Agency phone type

Alphabetical

  • Business

  • Mobile

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number

Attribute

CountryCode

Phone number to contact the Agency

Country code for phone number

Numeric

Numeric

Any

Mandatory for schema if "CountryCode" attribute is indicated.

Sender / TravelAgencySender / Contacts / Contact / Name / Surname

Reference Agency contact surname

Alphanumeric

Any

Mandatory for schema if 'Name' tag is indicated.

Sender / TravelAgencySender / Contacts / Contact / Name / Given

Reference Agency contact name

Alphanumeric

Any

Sender / TravelAgencySender / AgencyID

Id for the Agency.

Alphanumeric

Any

Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric

7 Numbers

Mandatory for schema if 'Participants' tag is indicated.

<Party> (With Corporates)

Schema

Sender / CorporateSender / ID

ID for the Corporate

Alphanumeric

Any

Not mandatory if included in previous AirShopping, as value stored in Offer Management caché will be used*

Participants / Participant / TravelAgencyParticipant / Name

Agency Name. It will be obtained by NDC_SELLERS table.

Alphanumeric

Any

Participants / Participant / TravelAgencyParticipant / Contacts / Contact

Attribute

ContactType

Field that agencies can inlclude to specify the information to include in confirmation mails.

  • itin_only

  • itin_and_price (default value)

Alphabetical

  • itin_only

  • itin_and_price (default value)

Mandatory for schema if "ContactType" attribute is indicated.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address

Email to contact the Agency

Alphanumeric

Any

Mandatory for schema if 'EmailContact' tag is indicated.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application

Agency phone type

Alphabetical

  • Business

  • Mobile

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number

Attribute

CountryCode

Phone number to contact the Agency

Country code for phone number

Numeric

Numeric

Any

Mandatory for schema if "CountryCode" attribute is indicated.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname

Reference Agency contact surname

Alphanumeric

Any

Mandatory for schema if 'Name' tag is indicated.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given

Reference Agency contact name

Alphanumeric

Any

Participants / Participant / TravelAgencyParticipant / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric

7/8 Numbers

NDC Mandatory

Participants / Participant / TravelAgencyParticipant / AgencyID

Id for the Agency

Alphanumeric

Any

Schema

Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric

7 Numbers

Mandatory for schema if 'Participants' tag is indicated.

<Query / Order>

Schema

Offer

Attribute

OfferID

Attribute

Owner

Attribute

ResponseID

Id of a returned offer

Airline code

Id of the response

Alphanumeric

Alphabetical

Alphanumeric

Any

Any

Any

Schema

Offer / OfferItem

Attribute

OfferItemID

Id for OfferItem

Alphanumeric

Any

Schema

Offer / OfferItem / PassengerRefs

Type of passenger

Alphanumeric

Type of Passengers

Schema

Offer / OfferItem / ALaCarteSelection / Quantity

Quantity of ancillaries

Numeric

Any

Mandatory for schema if "ALaCarteSelection" tag is indicated

Offer / OfferItem / ALaCarteSelection / SegmentID

Id for the segment that applies the ancillaries

Alphanumeric

Any

Offer / OfferItem / SeatSelection / Row

Row for the seat

Numeric

Any

Mandatory for schema if "SeatSelection" tag is indicated

Offer / OfferItem / Seat Selection / Column

Column for the seat

Alphabetical

Any

Mandatory for schema if "SeatSelection" tag is indicated

Offer / OfferItem / ServiceSelection

Attribute

ServiceID

Id for the special service

Alphanumeric

Any

NDC Mandatory for Special Needs selections.

Offer / OfferItem / ServiceSelection / ServiceDefinitionID

Definition for the special service

4 Alphabetical

Special Services

Mandatory for schema if "ServiceSelection" tag is indicated

<Query / Payments / Payment>

Schema

Type

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

Please check here.

Alphabetic

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

  • SF (ServiceFee)

Schema

--  This refers to Cash payment method  --

Method / Cash

Attribute

CashInd

Cash payment method.

Alphabetic

true

NDC Mandatory

----

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

Method / PaymentCard

Attribute

refs

3DS and intallments references. This references has to be necesarilly related and associated to 3DS info introduced in PaymentCardSecureInfo tag and/or intallments payment info introduced in PaymentFormMetadata MetadataKey.

Two possible references ​​separated by a space.

One reference have to match with 3DS info in PaymentCardSecureInfo ObjectKey.
The other reference have to match with intallments payment info in PaymentFormMetadata MetadataKey.

Alphanumeric

Any

NDC Mandatory for 3DS and/or intallments payments.

Method / PaymentCard / CardType 

Type of credit card

Alphanumeric

1-6 characters

NDC Mandatory

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-19 characters

NDC Mandatory

Method / PaymentCard / SeriesCode

Series Code of credit card

Numeric

1-8 characters

NDC Mandatory

Method / PaymentCard / CardHolderName

Card Holder Name

Alphanumeric

0-50 characters

Method / PaymentCard / CardHolderBillingAddress / Street

Street of the billing address of the cardholder

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

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

Method / PaymentCard / CardHolderBillingAddress / CityName

City of the Billing Address of cardholder

Alphanumeric

Only first 50 characters will be considered

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

Method / PaymentCard / CardHolderBillingAddress / StateProv

State Prov. of the Billing Address of cardholder

Alphanumeric

1-40 characters

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

Method / PaymentCard / CardHolderBillingAddress / PostalCode

Postal Code of the Billing Address of cardholder

Alphanumeric

2-10 characters

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

Method / PaymentCard / CardHolderBillingAddress / CountryCode

Country Code of the Billing Address of cardholder

Alphabetic

2 characters

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

Method / PaymentCard / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 characters

NDC Mandatory

----

--  This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

Alphabetic

true

NDC Mandatory

Method / Voucher / Number 

Number of the voucher

Alphanumeric

any

Iberia NDC

----

--  This refers to Service Fee method  --

Method / Other / Remarks

Attribute

refs

References for all passengers of the order

Alphanumeric

any

NDC Mandatory

Method / Other / Remarks / Remark

Service Fee payment method

Alphabetic

ServiceFee

Mandatory for schema if "Remarks" tag is indicated

Amount

Total amount of the offer

Numeric

Any

Schema

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.

Iberia NDC

In Cash Payment Method is OPTIONAL

<Query / BookingReferences / BookingReference>

ID

External reference ID

Alphabetical

XRef

Mandatory for Sender External Reference

OtherID

Attribute

Name

This attribute must contain the senders IATA Number and will be matched against the Senders IATANumber from TravelAgencySender

Numeric

7/8 Numbers

Mandatory for Sender External Reference

OtherID

Sender's external reference

Alphanumeric

Any (Strings exceeding 30 chars will be truncated)

Mandatory for Sender External Reference

<DataLists / PassengerList / Passenger>

Schema

Passenger

Attribute

PassengerID

Type of passenger

PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.

Alphanumeric

Alphanumeric

Type of Passengers

Value indicated in PassengerID attribute from AirShopping request

Schema

PTC

Passenger Type Code

3 Alphabetical 

Type of Passengers

BirthDate

Birthdate of the passenger (Mandatory for secure flights for all passengers)

Birthdate of the passenger (Always mandatory for CHD and INF Passengers)

Date

Date depends of the PTC

Schema

Individual

Attribute

IndividualID

Id for the passenger, for internal use only.

Must be unique for each passenger at the order and can be referenced in Query / DataLists / ContactList / ContactInformation / IndividualRedf

Alphanumeric

Any

Passenger / Individual / Gender

Gender of the passenger.

In secure flight:

  • Mandatory for infant passengers

  • Mandatory for all other passengers if the title is not indicated

Alphabetical

  • Male

  • Female

Mandatory for secure flights and infant passengers.

Passenger / Individual / NameTitle

Title of the passenger
NDC supports followings fields (MR, MRS, MS, MISS). If another field is introduced no error is shown, only this field is ignored.

In secure flight:

  • Optional for infant passengers

  • Mandatory for all other passengers if the gender is not indicated

Alphabetical

  • MR

  • MRS

  • MS

  • MSS

  • MISS

Mandatory for secure flights

Individual / GivenName

Name of the passenger

Alphabetical

Any

NDC Mandatory

Individual / Surname

Surname of the passenger

  • (Agency can specify separated by a special character "@" first and second surname → Ex: De la Morena@López)

Alphabetical

Any

Mandatory for schema if 'GivenName' tag is indicated.

Individual / SurnameSuffix

Can be used to indicate that the individual holds a position, educational degree, accreditation, office, or honor.

Can be used to distinguish between two passengers with exactly the same NameTitle, GivenName and Surname.

Alphabetical

Any

  • JR

  • SR

Mandatory if NameTitle, GivenName and Surname are the same for two passengers.

LoyaltyProgramAccount / Airline / AirlineDesignator

Airline ID

Alphanumeric

Any

Mandatory if 'LoyaltyProgramAccount' tag is indicated

LoyaltyProgramAccount / AccountNumber

Frequent Flyer number account

OnBusiness account number, must start with “OB” (e.g. OB12345678)

Alphanumeric

Any

Mandatory if 'LoyaltyProgramAccount' tag is indicated

FOID / FOID_Number

Number for the document

Alphanumeric

PP (Passport): Any sequence of alpha numeric characters, also "-" and "." characters are accepted.

Valid examples: 1234-ABC, G.12345

NI (National ID): Only alpha numeric charaters are allowed

Valid examples:

X1234567S

123456789012A

Mandatory for schema if 'FOID' tag is indicated.

FOID / FOID_Type

Type of the passenger ID Info

2 Alphanumeric

  • PP (Passsport) - Not valid for Spanish Resident and Large Family discounts

  • NI (National ID)

Mandatory for schema if 'FOID' tag is indicated.

InfantRef

Indicates the infant associated to this adult.

If this tag is not indicated, automatic association is applied by Iberia

Alphanumeric

Reference to infant PassengerID tag

IdentityDocument / IdentityDocumentNumber

If Type of document is:

  • F1 - this will be the Spanish Resident certificate number 

(Optional if Spanish DNI/NIE is sent. Validated only if sent without Spanish DNI/NIE)

  • AI - this will be the Large Family certificate number

  • F - this should be the relevant fiscal information for the country.

    • The information should be sent using the following two or three elements separated by obliques "/":

      • Document Type

      • Document Number/ID

      • Company Name (optional)

    • examples:

      • "RUC/12345678X/BIG COMPANY"

      • “CUIL/9393933333

    • This fiscal information will be included on the tickets as required by local laws.

  • If any unacceptable information is sent and not included in the reservation/tickets, a warning message will be returned in the OrderViewRS.

Alphanumeric

  • 12 characters maximum for residence document

  • 20 characters maximum for large family document

  • 70 characters maximum for FiscalId

Mandatory for schema if 'IdentityDocument' tag is indicated 

NDC Mandatory for POS PE & EC (FiscalId). For Infant passengers is not mandatory, so case that this document doesn’t come it will be assign the fiscal documentation from one of the Adults passengers.

IdentityDocument / IdentityDocumentType

Type of document

2 Alphanumeric

  • F1 (Resident Discount)

  • AI (Additional information, Large Family Discount)

  • F (FiscalId)

  • Any other document

Mandatory for schema if 'IdentityDocument' tag is indicated 

NDC Mandatory for POS PE & EC (FiscalId)

ContactInfoRef

Reference for passenger contact info

Alphanumeric

Any

Schema

Remark / Remark

Municipality of residence / Community code for large family

Alphanumeric

  • RESIDENT-Code of Location

  • LARGEFAMILY-Code of Comunity

INE - Relación de municipios y códigos por provincias

Mandatory for schema if 'IdentityDocument' tag is indicated.

<DataLists / ContactList>

ContactInformation

Attribute

ContactID

Reference for the contact info, payer info…that must be associated correctly in the XML above.

Alphanumeric

Any valid reference associated in the XML above.

Mandatory if 'ContactInfoRef' tag is indicated

ContactInformation / ContactType

Field that agencies can include to specify the information to include in confirmation mails.

  • itin_only (omits the pricing

  • itin_and_price (which is the default value)

  • not_send_mail

Field that agencies can include to specify the contact type information:

  • Payer

Alphabetical

  • itin_only (omits the pricing

  • itin_and_price (which is the default value)

  • not_send_mail

  • Payer

ContactInformation / ContactProvided / EmailAddress / EmailAddressValue

Email associated to contact or payer passenger

Alphanumeric

Any

NDC and schema mandatory if payer contact info is informed.

ContactInformation / ContactProvided / Phone / Label

Label to identify the kind of telephone

  • Passenger

  • Emergency

Alphanumeric

Any (Passenger, Emergency...)

ContactInformation / ContactProvided / Phone / CountryDialingCode

Telephone country code

Alphaumeric

Any

ContactInformation / ContactProvided / Phone / PhoneNumber

Phone number for the label

Numeric

Any

ContactInformation / Individual / GivenName

Name for the emergency contact, payer...

Alphanumeric

Any

NDC Mandatory for Payer ContactID if XML tag below IndividualRef is not completed associating a specific passenger.

In Cash FOP is Optional to include payer.

ContactInformation / Individual / Surname

Surmane for the emergency contact, payer...

Alphanumeric

Any

Mandatory if 'Individual' tag is indicated

ContactInformation / IndividualRef

Reference for the passenger

Alphanumeric

Any

NDC Mandatory for Payer ContactID if XML tags above GivenName and Surname are not inlcuded.

In Cash FOP is Optional to include payer.

<DataLists / FlightSegmentList / FlightSegment>

FlightSegment

Attribute

SegmentKey

Id for the segment

Alphanumeric

Any

Mandatory if 'FreeFormTextInstruction' is indicated.

Departure / AirportCode

IATA 3 character code for the departure city/airport/station

3 Alphanumeric

Any

Departure / Date

Date of departure

Date

yyyy-MM-dd

Departure / Time

Hour of departure

Hour

HH:mm

Departure / AirportName

Name of the departure city/airport/station

Alphanumeric

Any

Departure / Terminal / Name

Name for the departure terminal at city/airport/station

Alphanumeric

Any

Arrival / AirportCode

IATA 3 character code for the arrival city/airport/station

3 Alphanumeric

Any

Arrival / Date

Date of arrival

Date

yyyy-MM-dd

Arrival / Time

Hour of arrival

Hour

HH:mm

Arrival / ChangeOfDay

Change of day between departure and arrival

1 Numeric

Any

Arrival / AirportName

Name of the arrival city/airport/station

Alphanumeric

Any

Arrival / Terminal / Name

Name for the arrival terminal at city/airport/station

Alphanumeric

Any

MarketingCarrier / AirlineID

Id for the airline that markets the flight

Alphabetical

Any

MarketingCarrier / Name

Name for the airline that markets the flight

Alphanumeric

Any

MarketingCarrier / FlightNumber

Marketing Flight number identifier (0449…)

Numeric (4 numbers)

Any

OperatingCarrier / AirlineID

Id for the airline that operates the flight

Alphabetical

Any

OperatingCarrier / Name

Name for the airline that operates the flight

Alphanumeric

Any

OperatingCarrier / FlightNumber

Operational Flight number identifier (3240…)

Numeric (4 numbers)

Any

OperatingCarrier / Disclosures / Description / Text

Description of the airline

Alphanumeric

Any

Equipment / AircraftCode

Code for the aircraft that operates the flight

Alphanumeric

Any

Equipment / Name

Name for the aircraft that operates the flight

Alphanumeric

Any

FlightDetail / FlightDuration / Value

Duration of the flight

Alphanumeric

Any

<DataLists / InstructionsList / Instruction>

Instruction

Attribute

ListKey

Id for the instruction to select sport equipment

Alphanumeric

Any

FreeFormTextInstruction

Attribute

refs

Reference for passenger and segments associated to selected sport equipment

Alphanumeric

PassengerID and SegmentID

Valid example: “ADULT_01 IB303420231016“

FreeFormTextInstruction / Remark

Selected sport equipment code

Alphanumeric

  • BIKE: BAGGAGE/SP/0EC

  • SKII: BAGGAGE/SP/0DD

  • GOLF: BAGGAGE/SP/0D4

  • SURF: BAGGAGE/SP/0D8

  • SCUB: BAGGAGE/SP/0EE

  • FISH: BAGGAGE/SP/0D6

<DataLists / ServiceDefinitionList>

ServiceDefinition

Attribute

ServiceDefinitionID

Special need service Identification, for example;

SPECIAL_NEED-DEAF

Alphabetical

Any

Mandatory if 'ServiceDefinitionList' tag is indicated

ServiceDefinition / Name

Special need name

Alphabetical

Any

Mandatory if 'ServiceDefinitionList' tag is indicated

ServiceDefinition / Descriptions / Description

Attribute

refs

Special need references, for example:

ADULT_01 ADULT_02

Alphanumeric

Any

Mandatory if 'ServiceDefinitionList' tag is indicated

ServiceDefinition / Descriptions / Description / Text

Explanatory note with addition information, such as if accompanied by a guide dog, with the weight of the animal.

Maximum 90 characters.

Alphanumeric

Any

ServiceDefinition / BookingInstructions / SSRCode

SSR Code value

Alphabetical

Special Services

NDC Mandatory

<Metadata / Other / OtherMetadata / PaymentFormMetadatas > ↔ 3DS INFO

PaymentFormMetadata

Attribute

MetadataKey

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

Mandatory if 'PaymentFormMetadatas' tag is indicated

Text

Installments payment info

Alphanumeric

installments/n

where n=number of installments.

Valid example: installments/3

Mandatory for installments payment

PaymentFormMetadata / AugmentationPoint / AugPoint

Attribute

Owner

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

Alphabetical

IB

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

Attribute

xsi:schemaLocation

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

Alphanumeric

3-D Secure Payment

PaymentFormMetadata / AugmentationPoint / AugPoint / Backport_IberiaSecurePayment

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

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

Attribute

ObjectKey

3DS reference.  This reference has to be necesarilly related and associated to 3DS Payment Card introduced.

This reference and reference introduced in PaymentCard refs will have to match, in this case 3DS info will be associated to payment card introduced.

Alphanumeric

Any

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

Version of 3D-Secure for which the card is enrolled. This tag is mandatory and if is not included, an error will be returned.

This field has to be filled in with specific 3DS version ussed to authenticate (1.0.2, 2.1.0, 2.2.0...)

Alphanumeric

Any

NDC Mandatory

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

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

This field has to be filled in with specific 3DS version ussed to authenticate (1.0.2, 2.1.0, 2.2.0...)

Alphanumeric

Any

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

NDC Mandatory 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.x2

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

Response Body

Order View RS v17

Error Messages

For further information about all kind of error messages, please go to the following link:

Error Codes

  • No labels