Air Doc Issue

AirDocIssue

The AirDocIssue API provides IATA Accredited Travel Agents, new retailers and Service Providers the ability to pay for the held booking.

The service uses IATA NDC AirDocIssueRQ & AirDocDisplayRS v2.0 schema

You can try this live service using I/O docs if you Register or Sign in with your Mashery ID.

Version Information

The most recent version of the AirDocIssue API is version 1. Previous versions are shown below.

VERSIONSTATUSEND-OF-LIFE DATE
v01 Current n/a

API Endpoints

AirDocIssue has a SOAP API endpoint.

The endpoints available are:

ENDPOINTURL
Live n/a
Test https://test.api.ba.com/selling-distribution/AirDocIssue/V1

API Methods

METHODURLDESCRIPTION
POST /selling-distribution/AirDocIssue/V1 pay for a held booking

HTTP Headers

HEADER NAMEDESCRIPTIONMANDATORY?EXAMPLE
client-key Your unique key used to authorise access to the API. Yes n/a

Search parameters

The various search parameters are described below:

 

NAMEDESCRIPTIONFORMATMANDATORY / OPTIONALEXAMPLEALLOWED VALUES
AirDocIssueRQ
@Version message version m 2.0 any
@PrimaryLangID O EN any
@AltLangID O EN any
Party/Sender/TravelAgencySender
Name Sender name alphabetic m Travel Agent plc any
Name/ Contacts/ Contact/ EmailContact/ Address Travel agency email address email address optional anagent@travelagent.com any valid email address
IATA_Number IATA number of the agent that created the order numeric mandatory (either) use your own IATA or non-IATA number any
OtherIDs/OtherID non-IATA number of the agent that created the order
AgencyID Agency ID alphanumeric mandatory this can be the same as Name any
Party/Participants/Participant:   Note: Populate Participant tag only if the calling client is an Aggregator or GDS
@SequenceNumber attribute sequence number of this participant in the message flow numeric mandatory 1 add 1 to the highest Participant@SequenceNumber
Name Participant name alphabetic optional aggregator plc any
ID Participant ID alphanumeric mandatory Example: 00123456 Aggregator ID provided by BA.The service validates this ID and allow only if the AggregatorID provided is valid
Query
TicketDocQuantity number of tickets to issue - always pass "1" mandatory 1
Query / TicketDocInfo / TravelerInfo / Name
Surname Payer’s surname or family (last) name mandatory SMITH
Given Payer’s given name or first name mandatory JOHN
Query / TicketDocInfo / OrderReference
OrderId Booking reference or PNR reference mandatory YOMH3W
@Owner attribute owner of the Order - always pass "BA" mandatory BA
Query / TicketDocInfo / Payments / Payment
Type / Code Type of payment being made mandatory CC (card) or CA (cash) IATA definition from codeset 9888
Amount Amount payable by Card or Cash. This should include card surcharge as well for card payment mandatory 200.00
Amount / Code Currency code mandatory GBP
Query / TicketDocInfo / Payments / Payment / PaymentCard
CardType type of card mandatory Credit or Debit
CardNumber the long card number mandatory 4111111111111111
SeriesCode card security code (CVC) numeric m 123
CardHolderName @refs attribute reference to passenger who is payer aplhanumeric m t1
Query / TicketDocInfo / Payments / Payment / PaymentCard / CardholderBillingAddress
Street street part of address (repeat as required) alphanumeric m (max 2) 1 ACACIA GARDENS any
PostalCode postcode (or ZIP code) alphanumeric m AB1 1AB any
CountryCode country code alphabetic m GB ISO country codes
County postal county name alphabetic o MIDDLESEX
Query / TicketDocInfo / Payments / Payment / PaymentCard / EffectiveExpireDate
Effective Effective validity date of payment card MMYY o 1214 any
Expiration Expiration validity date of payment card MMYY m 1219 any

Search parameters may be submitted in any order and are case insensitive.

Response elements

The following error codes may be returned by the service

AIRDOCISSUERS / INFOGROUP / ERROR / CODEMEANINGDESCRIPTION
102 Invalid/missing departure dates
110 Invalid Source of Business
200 Ok The request was successful and at least 1 item is being returned
304 System Temporarily unavailable
309 Unfulfilled Paid Service
316 Contact element (phone and/or address) missing
317 Contact element (phone and/or address) invalid
362 Unable to display PNR and/or name list
400 Bad Request Sent when the consumer sends a malformed request to the service. The actual error message is returned in the response body
401 Unauthorised Returned when the consumer is not authenticated to use the REST API
403 Forbidden Returned when the consumer is authenticated but does not have permission to access the Resource
406 Not Acceptable Returned when the Accept header contains version / mime type info which we don't support
420 Not Available but Waitlist is Open
421 Not Available and Waitlist is Closed
500 Internal Server Error Something has gone wrong - please raise this as a bug with us
503 Service Unavailable Returned when the server is temporarily unable to handle the request
708 Incorrect credit card information
709 Invalid or missing frequent traveller information
73E Unable to price – currency restrictions
794 Invalid or missing fare calculation
911 Unable to process - system error

Supported Status Codes

You can view the standard status codes returned by our APIs here.