AirDocIssue 16.2 Live
version: R2.55 - R2019.13
Message examples:
AirDocIssue.zip message examples
EndPoint:
- IATA NDC Schema Version 16.2: https://test.api.iberia.com/iberia/beta/ndc/AirDocIssue/v2
HTTP Headers
| api_key | Your unique key used to authorise access to the API. | Mandatory:Yes |
Request Body
= New
|
NAME |
DESCRIPTION |
FORMAT |
ALLOWED VALUES |
MANDATORY FOR |
| PrimaryLangID | Specifies preferred language by the agency | 2 alphabetic | any | |
| Version |
The IATA version of the message |
numeric | any | Schema |
| <PointOfSale> | NDC Mandatory | |||
|
Location / CountryCode |
Country code |
alphabetic |
NDC Mandatory if toggle feature for market validation is activated. | |
|
<Document> |
Schema | |||
|
ReferenceVersion |
The IATA Schema version. |
alphanumeric |
any |
|
| <Party / Sender / TravelAgencySender> | Schema | |||
|
IATA_Number |
Sender IATA or Pseudo IATA number |
numeric |
7/8 numbers |
NDC Mandatory |
|
AgencyID |
Agency identification |
alphanumeric |
any |
Schema |
| Name |
Agency Name |
alphanumeric | any | |
| <Party / Sender / TravelAgencySender / Contacts / Contact> | Mandatory for schema if 'Contacts' tag is indicated. | |||
| EmailContact / Address | Email to contact the Agency | alphanumeric | any | Mandatory for schema if 'EmailContact' tag is indicated. |
| PhoneContact / Application | Agency phone type | alphabetic |
|
|
|
PhoneContact / Number Attribute CountryCode |
Country code phone number to contact the Agency | alphanumeric | any | |
| Name / Surname | Reference Agency contact surname | alphanumeric | any | Mandatory for schema if 'Name' tag is indicated. |
| Name / Given | Reference Agency contact given | alphanumeric | any | |
| <Party / Participants> | ||||
|
Participants / Participant Attribute SequenceNumber |
Number of aggregator secuency connection | numeric | any | |
| Participant / AggregatorID | Aggregator ID of the participant which is connecting | numeric | 7/8 numbers | Mandatory for schema if 'Participants' tag is indicated. |
| <Query> | Schema | |||
| TicketDocQuantity | Number of tickets | Numeric | any | Schema |
|
TicketDocInfo / TravelerInfo / EmailContact / Address |
Passenger email address contact information. | alphanumeric | any | Mandatory for in case of credit card payment type. |
| TicketDocInfo / TravelerInfo / PhoneContact / Number | Passenger phone number contact information. | alphanumeric | any | Mandatory for in case of credit card payment type. |
| TicketDocInfo / TravelerInfo / Surname | Passenger's surname | alphanumeric | any | Schema |
| TicketDocInfo / TravelerInfo / Given | Passenger's name | alphanumeric | any | Schema |
| EmailContact / Address | Passenger's mail addres | alphanumeric | any | Mandatory for in case of credit card payment type. |
| PhoneContact / Number | Passenger's phone number | Numeric | any | Mandatory for in case of credit card payment type. |
| TicketDocInfo / OrderReference / OrderID | Order ID | alphanumeric | any | NDC Mandatory |
| TicketDocInfo / Payments / Payment / Type / Code | Code of payment | 2 alpha | Form of payments | Schema |
| TicketDocInfo / Payments / Payment / Amount | Total offer amount | Numeric | any | NDC Mandatory |
| Method |
Payment method, can be cash payment or card payment. In case of credit card payment the following elements are required:
|
Payment format | any | NDC Mandatory |
|
Method / PaymentCard / CardType |
Type of credit card |
alphanumeric |
1-6 characters |
|
Method / PaymentCard / CardNumber |
Number of credit card |
numeric |
1-19 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 |
alphanumeric |
1-40 characters |
|
Method / PaymentCard / CardHolderBillingAddress / CityName |
City of the Billing Address of cardholder |
alphanumeric |
1-24 characters |
|
Method / PaymentCard / CardHolderBillingAddress / StateProv |
State Prov. of the Billing Address of cardholder |
alphanumeric |
1-40 characters |
|
Method / PaymentCard / CardHolderBillingAddress / PostalCode |
Postal Code of the Billing Address of cardholder |
alphanumeric |
2-10 characters |
|
Method / PaymentCard / CardHolderBillingAddress / CountryCode |
Country Code of the Billing Address of cardholder |
alphabetic |
2 characters |
|
Method / PaymentCard / EffectiveExpireDate / Expiration |
Effective expiration date of the credit card |
numeric |
2 characters |
1.3 Response Body
1.4 Error messages
NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".
The following codes are enclosed in the response returned with a 200 OK.
|
PADIS STATUS CODE |
EXAMPLE MESSAGE ERROR |
REASON |
|
795 |
There's a mismatch between payment amount and total offer prices |
Incorrect amount |
|
486 |
Form of payment missing or invalid for ticket |
Without payment |
|
486 |
Full order must be paid/issued. Missing documents |
Payment not included for everything |
|
486 |
Form of payment missing or invalid for ticket/document |
Payment must be for everything in the order. |