Beruflich Dokumente
Kultur Dokumente
Technical Reference
Structure hierarchy
* A service contains an input message and an output message.
* A query/reply structure contains a list of simple structures and a list of grouped structures.
* A grouped structure contains a list of simple structures and a list of grouped structures.
* A simple structure contains a list of data elements and grouped data elements.
* A data element can be coded, therefore a code list is described in a separate table.
Document structure
* Service overview.
* Query and output messages for the service, with their corresponding description.
* For each query/reply structure, a table describing its higher level entities of the query/reply structure.
* For each grouped or simple structure, a table describing the entities they are built with.
* For each coded entity, a table describing the possible coded values it can take.
Grouped structures introduces the 'level' concept within a structure. This level is reflected in the structure tables
via indentation.
Document navigation
The document uses internal links to quickly navigate between referenced entities and its corresponding structure
and substructures (if any).
Glossary of terms
Entity definition
Every entity in this document is defined by:
M* (Mandatory) : This indicates that the status differs from the IATA PADIS Data Dictionary. If an entity is defined
as conditional in the IATA approved message but must be mandatory to complete a business function, the entity
will be indicated with an M for Mandatory along with an asterix (*).
Representation
Following table explains the meaning of possible representations for a leaf entity.
Representation Meaning
ax The entity is conveying a fix number(x) of alphabetic elements.
Table of contents
Operation: FOP_CreateFormOfPayment............................................................................... 1
Query message ................................................................................................................. 2
Reply message ..................................................................................................................4
Grouped structures ............................................................................................................... 6
Simple structures ................................................................................................................ 21
Codesets ............................................................................................................................. 85
i
Amadeus Programming Interface
Operation: FOP_CreateFormOfPayment .
fopGroup Group M 127 The group can contain up to 127 different FOPs
passengerAssociation Reference information C 99 will list all the passengers associated to the FOP
element
pnrElementAssociation Reference information C 99 will list the various links of the FOP element. it can
be MCO, Segment... (pax reference is conveyed
within PXR)
feeDetailsInfoGroup Group C 99
fopPNRDetails Ticketing form of M 1 will convey all the data related to the various codes
payment used by the FOP package, billing, ETS...
oldFopFreeflow Free text information C 1 This segment conveys Old Form of Payment. Old
FOP(s) are considered as one freeflow text even if
there is more than one old form of payment. e.g.:
FP O/CA+CCVI+/CH CA and CCVI are considered
as freeflow text.
pnrSupplementaryData Group C 2 will convey the switches and data associated to the
FOP table
paymentModule Group C 1 will contain all the data related to the payment
transaction
passengerAssociation Reference information C 99 will list all the passengers associated to the FOP
element
pnrElementAssociation Reference information C 99 will list the various links of the FOP element. it can
be MCO, Segment... (pax reference is conveyed
within PXR)
freeFlowFop Free text information C 1 Contains the FOP complete as displayed in the
PNR.
fpElementError Group C 1 will convey the reason of the error that occured
during Form of Payment reading
fopPNRDetails Ticketing form of M 1 will convey all the data related to the various codes
payment used by the FOP package, billing, ETS...
oldFopFreeflow Free text information C 1 This segment conveys Old Form of Payment. Old
FOP(s) are considered as one freeflow text even if
there is more than one old form of payment. e.g.:
FP O/CA+CCVI+/CH CA and CCVI are considered
as freeflow text.
pnrSupplementaryData Group C 2 will convey the switches and data associated to the
FOP table
mopElementError Group C 1 will convey the reason of the error that occured
during Method of Payment reading
paymentModule Group C 1 will contain all the data related to the payment
transaction
fortknoxIds Reference information C 2 will convey both the CVV and the Credit
card number Ids stored in the fortknox
Database
localDateTime Structured date time C 3 This segment conveys date and time
information information. You can specify the time
mode used (GMT, UTC or Local)and
what for it refers. - Transmission date
and time This contains the date and
time the request was submitted to the
link (Visa, Nedbank...field 7). GMT can
be used. - Local transaction date and
time Date and time when Amadeus
builds the authorization message (local
according to the point of sale)(Visa,
Nedbank...field 12/13) - Transaction
receipt date and time date and
time when amadeus receives the
authorization message.
payerPhoneOrEmail Phone and email C 2 will convey either the phone or the
address email adress of the payer
documentNumber Ticket number details M 1 Can convey the edoc number or the
primary ticket number
tdsBlbIdentifier Reference information M 1 will identify the content of the BLB that
follows
pspUrl Communication contact C 1 It will convey the Psp's URL where the
customer will be redirected to, in order
to perform its payment Type will be PP
Paypal url
fortknoxIds Reference information C 2 will convey both the CVV and the Credit
card number Ids stored in the fortknox
Database
currenciesExchangeRate Currencies M 1
purchaseDescription Free text information C 1 will convey in free text the description
of the purchase
issueIndicator Issue indicator C 1 an1 Issue indicator : 'F' --> First Issue 'R'
--> Reissue 'I' --> First issue of It 'Y'
--> Reissue of IT 'B' --> First issue of
BT 'W' --> Reissue of BT 'OB' --> OB
Fee calculation. Codeset list: 906T
1A 02.1.302
time Time C 1 n .. 9 .
startDate First date C 1 an4 This field indicates the date the Credit
Card was issued. This data is present
in case of (UK) maestro cards..
endDate First date C 1 an4 This field indicates the date the
Credit Card will not be valid anymore
This data is present in case of (UK)
maestro cards. May be different from
the expiry date.
issuingBankName Company identification C 1 an2 .. 3 will contain the code of the bank that
issued the credit card.
rawTrackData Raw CC Track Data C 1 an .. All the tracks of a swipe credit card
400 are contained here as one block..
Structure: ADDRESS
Entity Structure St Rep Fmt Comments
addressDetails Address details C 1 "" will convey the adress text
countryCode Country name code C 1 an .. 3 Country code. ISO 3166 code for the
country .
endDateTime Structured date time C 1 "" Convey the end date/time of a period.
information
authorResponseCode Point of service codes C 1 an2 Authorization response code Field 39.
code Time zone code C 1 n1 Time zone code. See SSIM appendix
F.. Codeset list: 337K 1A 02.1.1234
suffix Time zone suffix C 1 a1 Time zone suffix to complete the time
zone code when necessary. See
SSIM appendix F.. Codeset list: 341K
1A 02.1.1234
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaSetType Attribute function code C 1 an .. 3 Determines if the set of criteria
qualifier corresponds to the message
identification criteria or to normal
criteria.. Codeset list: 9017 UN
02.A.1243
indicator Status indicator, coded M* 1 an .. 3 FRA for fraud screening. Codeset list:
1245 IA 02.2.2025
otherNameDetails Traveller details C 1 "" will convey the CC holder first name
Structure: ADDRESS
Entity Structure St Rep Fmt Comments
addressDetails Address details C 1 "" will convey the adress text
countryCode Country name code C 1 an .. 3 Country code. ISO 3166 code for the
country .
pinCodeType PIN code type C 1 an .. 8 Details pin code type (in case of
encrypted pin code).
otherFormOfPayment Form of payment details C 98 " " Contains the Account data, the
transaction data and financial data
pinCodeType PIN code type C 1 an .. 8 Details pin code type (in case of
encrypted pin code).
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaSetType Attribute function code C 1 an .. 3 Type of Data related to FOP account,
qualifier ex: ACC = account info . Codeset list:
9017 UN 02.A.1867
criteriaDetails Attribute information M 999 " " Details for the message criteria
(name, value).
controlType Reservation control type C 1 an1 Type. Codeset list: 9958 1A 11.1.133
inConnectionWith Document/message C 1 an .. 35 .
number
type Duty or tax or fee type C 1 an .. 3 Nature tax code. Codeset list: 5153
name code 1A 10.1.155
inConnectionWith Document/message C 1 an .. 35 .
number
originatorTypeCode Originator type code C 1 an1 Originator Type Code. A for airline
agent. T for travel Agent. E for
internet.. Codeset list: 9972 IA
01.2.99
time Time C 1 n .. 9 .
quantity Quantity C 1 n .. 15 .
age Age C 1 n .. 3 .
rate Percentage C 1 n .. 8 .
commodityCategory Commodity/rate C 1 an .. 18 .
identification
percentage Percentage C 1 n .. 8 .
trueLocation Place/location C 1 an .. 17 .
trueLocation Place/location C 1 an .. 17 .
pinCodeType PIN code type C 1 an .. 8 Details pin code type (in case of
encrypted pin code).
endDateTime Structured date time C 1 "" Convey the end date/time of a period.
information
code Time zone code C 1 n1 Time zone code. See SSIM appendix
F.. Codeset list: 337K 1A 02.1.2624
suffix Time zone suffix C 1 a1 Time zone suffix to complete the time
zone code when necessary. See
SSIM appendix F.. Codeset list: 341K
1A 02.1.2624
attributeDetails Coded attribute M 99 " " provides details for the Attribute
information
freeText Long Free Text M 1 an .. Free text explaining the error code.
199
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaDetails Attribute information M 99 " " Details for the message criteria
(name, value).
dataType DATA TYPE C 1 an1 type of the data. Codeset list: 116Z
1A 02.1.738
Structure: ADDRESS
Entity Structure St Rep Fmt Comments
addressUsageDetails Address usage C 1 "" Payer address usage
status Address status code C 1 an .. 3 Status of the street adress on file with
the payment provider(Paypal for eg).
Codeset list: 3475 UN 02.A.182
type Reference qualifier M* 1 an .. 3 nature of the bank id. Here: CUS for
customer bank. Codeset list: 1153 IA
02.2.2519
Structure: LANGUAGE
Entity Structure St Rep Fmt Comments
languageQualifier Language code qualifier M 1 an .. 3 will be 6 for our case. Codeset list:
3455 UN 02.A.15
Structure: ADDRESS
Entity Structure St Rep Fmt Comments
city City name M* 1 an .. 35 City name..
typeQualifier Monetary amount type M 1 an .. 3 Here is the list and the purpose of
qualifier each amount today stored in the
FP: I Transaction total amount Total
amount authorized in authorization
transaction IPC Transaction total
amount in PNR currency Total
amount authorized is also stored in
PNR currency. Indeed, reversal must
be done with the rate of exchange
valid at time of authorization and
therefore this avoids storing the
rate of exchange and performing
amount conversion at reversal time.
IT Initial TST total amount Amount
of TST multiplied by the number of
passengers associated to the TST
ITC Initial TST total amount in PNR
currency IT amount in PNR currency
for same reason as IPC amount R
Total amount / Remaining amount
Current authorized amount. Originally
it is the total amount authorized and
then this amount may decrease in
case of total/partial reversal. T Initial
Tst Individual amount Amount of TST
TPC Initial Tst Individual amount
in PNR currency Amount of TST in
PNR currency for same reason as
IPC amount AUT Authorized Amount
Maybe different from the one given
in input(for exple, if on input we have
2pax and the amount per pax. In case
of bulk, we will authorize the sum of
both amounts) It can also be used for:
Total Fare Amount 712 or additional
collection amount A. Codeset list:
5025 1A 02.2.617
typeQualifier Monetary amount type M 1 an .. 3 Here is the list and the purpose of
qualifier each amount today stored in the
FP: I Transaction total amount Total
amount authorized in authorization
transaction IPC Transaction total
amount in PNR currency Total
amount authorized is also stored in
PNR currency. Indeed, reversal must
be done with the rate of exchange
valid at time of authorization and
therefore this avoids storing the
rate of exchange and performing
amount conversion at reversal time.
IT Initial TST total amount Amount
of TST multiplied by the number of
passengers associated to the TST
ITC Initial TST total amount in PNR
currency IT amount in PNR currency
for same reason as IPC amount R
Total amount / Remaining amount
Current authorized amount. Originally
it is the total amount authorized and
then this amount may decrease in
case of total/partial reversal. T Initial
Tst Individual amount Amount of TST
TPC Initial Tst Individual amount
in PNR currency Amount of TST in
PNR currency for same reason as
IPC amount AUT Authorized Amount
Maybe different from the one given
in input(for exple, if on input we have
2pax and the amount per pax. In case
of bulk, we will authorize the sum of
both amounts) It can also be used for:
Total Fare Amount 712 or additional
collection amount A. Codeset list:
5025 1A 02.2.617
Structure: CURRENCIES
Entity Structure St Rep Fmt Comments
firstCurrencyDetails Currency details C 1 ""
sliderPosition Number of unit details C 2 "" Used to convey - Slider rank - number
of positions possible on the slider
Structure: FREQUENCY
Entity Structure St Rep Fmt Comments
extendedPaymentDetails Frequency M 1 "" extended payment characteristics
Structure: QUANTITY
Entity Structure St Rep Fmt Comments
quantityDetails Quantity details M 20 " " To specify an appropriate quantity.
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaSetType Attribute function code M* 1 an .. 3 Type of Data Exple : SAL sale
qualifier indicator EXT for extended payment
criteriaDetails Attribute information M 999 " " Details for the message criteria
(name, value).
Structure: MEASUREMENTS
Entity Structure St Rep Fmt Comments
measurementQualifier Measurement C 1 an .. 3 defines the type of the given measure
application qualifier will be FRA in our case. Codeset list:
6311 IA 02.2.48
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaSetType Attribute function code M* 1 an .. 3 Type of information: - is this a
qualifier switch? - is this a structured data?.
Codeset list: 9017 UN 02.A.937
criteriaDetails Attribute information M 999 " " Details for the message criteria
(name, value).
Structure: ATTRIBUTE
Entity Structure St Rep Fmt Comments
criteriaSetType Attribute function code M* 1 an .. 3 Type of information: - is this a
qualifier switch? - is this a structured data?.
Codeset list: 9017 UN 02.A.1559
criteriaDetails Attribute information M 999 " " Details for the message criteria
(name, value).
Codesets
1 Yes
Value Description
No specific codeset defined for this data element.
Value Description
PNR PNR
Codeset for Code list responsible agency, coded (Ref: 3055 IA 02.2.1797)
Value Description
1A Amadeus
IDE iDEAL
Codeset for Code list responsible agency, coded (Ref: 3055 IA 02.2.1799)
Value Description
13 ICAO (International Civil Aviation Organization)
2 CEC (Commission of the European Communities)
3 IATA (International Air Transport Association)
5 ISO (International Organization of Standardization)
6 IATCI
ZZZ Mutually defined
Codeset for Code list responsible agency, coded (Ref: 3055 IA 02.2.2045)
Value Description
1A AMADEUS
ZZZ Mutually defined
Codeset for Code list responsible agency, coded (Ref: 3055 IA 02.2.2247)
Value Description
PP Paypal
Codeset for Code list responsible agency, coded (Ref: 3055 1A 10.1.1939)
Value Description
No specific codeset defined for this data element.
Codeset for Date or time or period format code (Ref: 2379 UN 02.A.67)
Value Description
10 CCYYMMDDTHHMM
101 YYMMDD
102 CCYYMMDD
103 YYWWD
105 YYDDD
106 MMDD
107 DDD
108 WW
109 MM
110 DD
2 DDMMYY
201 YYMMDDHHMM
202 YYMMDDHHMMSS
203 CCYYMMDDHHMM
204 CCYYMMDDHHMMSS
205 CCYYMMDDHHMMZHHMM
3 MMDDYY
301 YYMMDDHHMMZZZ
302 YYMMDDHHMMSSZZZ
303 CCYYMMDDHHMMZZZ
304 CCYYMMDDHHMMSSZZZ
305 MMDDHHMM
306 DDHHMM
4 DDMMCCYY
401 HHMM
402 HHMMSS
404 HHMMSSZZZ
405 MMMMSS
406 ZHHMM
5 DDMMCCYYHHMM
501 HHMMHHMM
502 HHMMSS-HHMMSS
503 HHMMSSZZZ-HHMMSSZZZ
6 CCYYMMB
600 CC
601 YY
602 CCYY
603 YYS
604 CCYYS
608 CCYYQ
609 YYMM
610 CCYYMM
613 YYMMA
614 CCYYMMA
615 YYWW
616 CCYYWW
7 CCYYMMW
701 YY-YY
702 CCYY-CCYY
703 YYS-YYS
704 CCYYS-CCYYS
705 YYPYYP
706 CCYYP-CCYYP
707 YYQ-YYQ
708 CCYYQ-CCYYQ
709 YYMM-YYMM
710 CCYYMM-CCYYMM
711 CCYYMMDD-CCYYMMDD
713 YYMMDDHHMM-YYMMDDHHMM
715 YYWW-YYWW
716 CCYYWW-CCYYWW
717 YYMMDD-YYMMDD
718 CCYYMMDD-CCYYMMDD
719 CCYYMMDDHHMM-CCYYMMDDHHMM
720 DHHMM-DHHMM
8 CCYYMMDDS
801 Year
802 Month
803 Week
804 Day
805 Hour
806 Minute
807 Second
808 Semester
809 Four months period
810 Trimester
811 Half month
812 Ten days
813 Day of the week
814 Working days
9 CCYYMMDDPP
Codeset for Duty or tax or fee type name code (Ref: 5153 1A 10.1.155)
Value Description
No specific codeset defined for this data element.
Value Description
No specific codeset defined for this data element.
Value Description
No specific codeset defined for this data element.
Value Description
E e-mail
P phone
N No Bulk
S Superbulk
Value Description
700 Data not available
701 Amount is a Percentage
702 Specified routing may apply - check carrier and/or connection
703 TPM deduction may apply - check carrier and/or connection
704 TPM deduction applied
A Age
B Alternate Seat
C Coupon
FR First number in range of seats
G Kilometers
GLI Imperial gallons (4,546092 dm3)
GLL Liquid Gallon (US) (3,78541 dm3)
K Kilograms
L Pounds
LR Last number in range of seats
LTR Liters
M Mileage
MIN Duration in minutes
ONZ Ounce GB, US (28,349523 g)
OZA Fluid Ounce (29,5735 cm3)
OZI Fluid Ounce (28,413 cm3)
P Points
S Seat number
D Direct consumer
E Electronic selling system (e.g. Minitel, Compuserve)
G General Sales Agent
I Internal CRS locations (sales, development, etc.)
N Non IATA Agents
P Pending IATA Agents
S Self service machine
T Travel Agent
V Vendor (car, hotel, airline, travel supplier, etc.)
W Wholesaler (Tour operator)
X Bogus subscribers, used for testing
Value Description
EBANK e-Bank
Value Description
No specific codeset defined for this data element.
Value Description
No specific codeset defined for this data element.
Value Description
CVT ConVerTer Mode
SLD SLider mode
Q7 From 8 to 10 ft height