Paxgateway API Documentation

Table of Contents

1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1. Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2. URI scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.4. Conversation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5. API Key Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5.1. Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5.2. Request HTTP Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.6. Date Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.7. Client IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.8. Version Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.8.1. Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.8.2. Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.9. Currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.9.1. Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.9.2. Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.10. Accept-Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.10.1. Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.10.2. Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.11. Health Check Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.12. Procedure Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.13. List of Response Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.14. IOS Wallet Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.14.1. Certificates, images and definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.14.2. Customize and configure your ticket.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.14.3. Who send certificates/images/definitions?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.14.4. How to Call a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.15. Find Country User From Client IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.15.1. How to update Embedded IP Database? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.16. Book On Hold Payment Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.17. JWT(Json Web Token) Encryption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.17.1. How Can Be Create And Sertificate RSA Private/Public Key. . . . . . . . . . . . . . . . . . . . . . 21
1.17.2. Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.18. Disable Services Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.18.1. e.g → logging.ignored.endpoints=/definitions/currencies, /definitions/languages . . 23
2. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.1. Auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.1.1. Authenticate Editor for caching operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.1.2. Authenticate User for Loyalty Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.2. Availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.2.1. Available Flights Search Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.2.2. Available Cheapest Flights Search Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.2.3. Extra Charges Information Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.3. Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.3.1. Clear pax-gateway caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.3.2. Refresh PAX cache’s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
2.4. Checkin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.4.1. Retrieves available flights for check-in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.4.2. Get Passenger(s) For Checkin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.4.3. boardingpass with segmentId and passengerList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.4.4. boarding pass for ios wallet integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.4.5. Gets boarding pass with passengerHashValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.4.6. Cancel check-in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.4.7. Gets expected seats for passengers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.4.8. Available Arrival Ports For Kiosks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.4.9. Available Flights For Kiosks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.4.10. Available Passengers For Kiosks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.4.11. Performs check-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.4.12. Get Apis Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.4.13. Sends boarding pass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
2.5. Common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.5.1. Age Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.5.2. Cabin types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.5.3. Retrieve Known City Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.5.4. Supported Currencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
2.5.5. Supported Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.5.6. Retrieve Name Title Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.5.7. General parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.5.8. Known Airport Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.5.9. Known Airport Matrix (filtered) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.5.10. Retrieve Known Airport Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.5.11. Known Airport List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.5.12. Get Ports Of Countries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.5.13. Trip Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
 2.5.14. Retrieve Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2.5.15. Translations resource service.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
2.5.16. Client Version Control Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
2.6. Flight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.6.1. FlightSchedule Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.6.2. Flight status by flight number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2.6.3. Flight status by airport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.7. HealthCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.7.1. BL Health Check Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.7.2. Detailed health check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
2.7.3. Pax Gateway Health Check Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
2.7.4. Payment Service (Sapay) Health Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.8. Insurance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.8.1. Add Insurance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.8.2. Get Available Insurances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.8.3. Delete Insurance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2.9. Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.9.1. Login for invoice services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.9.2. Logout for invoice services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.9.3. View for invoice services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.10. Loyalty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.10.1. Activates membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.10.2. Retrieve available loyalty partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.10.3. Change member pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.10.4. Get city list with country code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
2.10.5. Claim reward miles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.10.6. Enroll Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2.10.7. Retrieve expected earned miles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
2.10.8. Retrieve Member Card Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
2.10.9. Retrieve Member Miles Sale Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
2.10.10. Retrieve Member Miles To Be Expired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
2.10.11. Retrieve Member Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
2.10.12. Retrieve Member Statement Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
2.10.13. Retrieve Member Transaction List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.10.14. Retrieve Personal Information Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
2.10.15. Retrieve profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
2.10.16. Retrieve Purchase Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
2.10.17. Retrieve Required Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
 2.10.18. Retrieve Member Reservation List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
2.10.19. Send member Pin via EMail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
2.10.20. Updates member profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.11. Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.11.1. Authorize payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.11.2. Authorize After Redirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
2.11.3. Credit card options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
2.11.4. Initialize Payment Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
2.11.5. Loyalty redemption options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
2.11.6. Payment options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
2.11.7. Retrieve Payment Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
2.12. Reservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
2.12.1. Checks for available discounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
2.12.2. Retrieve Available Packages(Bundles) Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
2.12.3. Check Phone Number is eligable for sending sms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
2.12.4. Cancels a booking or some of its segments. Segment calcellation is not supported
for non ticketed reservations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
2.12.5. Send HES code and check her/him available for the flight. . . . . . . . . . . . . . . . . . . . . . 101
2.12.6. Modify Exists Contact(s) Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
2.12.7. Retrieves Contact(s) Informations Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
2.12.8. Booking Create Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.12.9. Set discount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
2.12.10. Remove discount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
2.12.11. Sets invoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
2.12.12. Delete invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
2.12.13. Retrieves booking with carousel options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
2.12.14. Add New Package(Bundle) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2.12.15. Modify Passenger Informations Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
2.12.16. Retrieves passenger informations Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
2.12.17. Required to the trigger mail’s and text messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
2.12.18. Retrieves available price freezing options for booking. . . . . . . . . . . . . . . . . . . . . . . . 114
2.12.19. Purchases price freezing option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
2.12.20. Modifies flights of a booking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
2.12.21. Retrieves booking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
2.12.22. Retrieves booking from the conversation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2.12.23. HES code summary information passenger by passenger . . . . . . . . . . . . . . . . . . . . . 118
2.12.24. HES code requirement check service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
2.13. Ssr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
 2.13.1. Add or Modify booking SSR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
2.13.2. Available SSR list for reservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
2.13.3. Delete booking SSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
2.13.4. Extra baggage rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
2.13.5. Fare information for baggages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
2.13.6. Add or Modify booking SSR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
2.13.7. Delete SSR as Bath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
2.13.8. SeatMap Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
2.14. Ticketing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
2.14.1. Ticket Information for the print etc.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
2.14.2. Ticket without payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
2.14.3. Ticket Information for the print etc. with ticket number. . . . . . . . . . . . . . . . . . . . . . . 130
3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.1. AbstractMemberProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.2. AbstractSsr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.3. ActionDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.4. AddInsuranceRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.5. Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.6. Age. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.7. AgeLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.8. AgeLimitResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.9. AirReservationInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.10. AirTravelActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.11. Aircraft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.12. AirlineData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.13. AirlinePax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.14. AirlineSegment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.15. AllowedAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.16. ApisField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.17. ApisRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.18. ApisResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.19. Arranger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.20. AssociatedCoupon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.21. AsvcSsr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.22. AuthenticateUserRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.23. AuthorizationResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.24. AuthorizePaymentAfterRedirectRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.25. AuthorizePaymentRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3.26. AuthorizePaymentResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.27. AvailabilityRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
3.28. AvailabilityResponseItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.29. AvailableBaggage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.30. AvailableDiscount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.31. AvailableSsr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.32. AvailableSsrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.33. BaggageAllowance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
3.34. BaggageFareResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.35. BaggageRuleResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.36. BankInformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.37. BaseFarePrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.38. BaseFlightBasedActionDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
3.39. BasePaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
3.40. BillingData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.41. BkmExpressDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.42. BkmPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
3.43. BoardingCard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
3.44. BoardingCardLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
3.45. BoardingCardRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.46. BoardingCardSSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.47. BookOnHoldDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
3.48. BookOnHoldPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.49. Booking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.50. BookingRequestItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
3.51. CancelBookingRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
3.52. CancelCheckInRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.53. CancelCheckInResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.54. CancelFlightAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.55. CashDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.56. CashPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
3.57. Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.58. CclDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.59. ChangeFlightAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.60. ChangeMemberPinRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.61. ChangeableData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.62. ChargedSms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.63. CheapestFlightsFare. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.64. CheapestFlightsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
3.65. CheapestFlightsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
3.66. CheckHesCodeByPassengerRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
3.67. CheckHesCodeByPassengerResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
3.68. CheckInInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.69. CheckInRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
3.70. CheckInResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.71. CheckTwoFactorAuthRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.72. ChequePayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.73. ChequePaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
3.74. ChupopPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.75. City. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.76. CityList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.77. CityPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.78. ClaimRewardMilesRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.79. CodeValuePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
3.80. CodedPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
3.81. CommunicationPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
3.82. Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
3.83. CompanyInvoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.84. ConjunctiveTicket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.85. Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.86. CountryInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.87. Coupon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
3.88. CouponSegment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
3.89. CreditCardDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
3.90. CreditCartPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.91. Currencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
3.92. Currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.93. DcsBaggage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.94. DeleteInsuranceRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.95. Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.96. DirectDebitDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.97. Discount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
3.98. Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.99. DummyPosPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.100. ElectronicDocumentDeliveryPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.101. Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.102. EmdPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.103. EnrollMemberRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.104. EnrollMemberResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.105. ErrorResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.106. ExpectedEarnedMilesResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.107. ExternallyHandledPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.108. ExternallyHandledPaymentTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.109. ExtraCharges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.110. Fare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.111. FarePrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
3.112. FareSegmentCodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.113. FawryPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.114. Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
3.115. FeedbackAttachment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.116. FeedbackAttachmentRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.117. FeedbackOwner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.118. Flight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.119. FlightAction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
3.120. FlightInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.121. FlightInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.122. FlightLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.123. FlightRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.124. FlightSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.125. FlightScheduleDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.126. FlightScheduleRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.127. FlightScheduleResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.128. FlightStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.129. FlightStatusByNumberRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.130. FlightStatusByPortRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.131. FlightStatusDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.132. FlightStatusResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.133. GeneralParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.134. GetFeedbackRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.135. GiftCardPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.136. GirogatePayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.137. GirogatePaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.138. GovernmentReceiptPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.139. HesCodeRequired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
3.140. IatciCheckInInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
3.141. InitializePaymentRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.142. InitializePaymentResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.143. InlineFormPaymentParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.144. Insurance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.145. InsuranceDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.146. InsurancePassenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.147. Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.148. InvoiceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.149. InvoiceLoginRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
3.150. InvoiceLoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
3.151. InvoiceViewItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.152. InvoiceViewRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.153. InvoiceViewResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.154. Itinerary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.155. Journey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.156. JourneysByDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.157. KioskArrivalCity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.158. KioskArrivalCountry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
3.159. KioskArrivalPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
3.160. KioskArrivalPortsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
3.161. KioskAvailablePassengersRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
3.162. Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.163. Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.164. LocationInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.165. LocationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.166. LoyaltyPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
3.167. LoyaltyRedemptionDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
3.168. LoyaltyRedemptionPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.169. ManageBooking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.170. ManageBookingAction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
3.171. ManageBookingOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
3.172. MasterpassPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
3.173. McoInvPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.174. MeasureUnit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.175. MemberActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.176. MemberAddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.177. MemberCardDataResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
3.178. MemberEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.179. MemberPersonalInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.180. MemberPersonalInfoDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.181. MemberPhoneNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.182. MemberProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
3.183. MemberStatement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.184. MemberStatementDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.185. MemberTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.186. MemberTransactionListRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
3.187. MilesPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
3.188. MilesToBeExpired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.189. MiscChargeOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.190. MsPiaPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
3.191. NewPackagesRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.192. OperatingAirline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
3.193. OperationPurpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
3.194. OperationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
3.195. OriginalIssueAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.196. OtherPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.197. Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.198. PackagePrice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
3.199. Passenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.200. PassengerDcsInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
3.201. PassengerInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
3.202. PassengerListBasedOnTicket. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.203. PassengerListBasedOnVoucher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.204. PassengerSeatInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.205. PassengerSimpleInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
3.206. PassengersRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
3.207. PaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.208. PaymentOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
3.209. PaymentRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
3.210. PaymentRequestBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
3.211. PersonalInvoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
3.212. PhoneNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.213. Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.214. PortList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.215. PortMatrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.216. PortType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
3.217. Price. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.218. PriceBase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.219. PriceDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.220. PriceFreezingOption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.221. PriceOverview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.222. PricePerPassenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.223. PriceResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.224. PrintTicket. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.225. PspInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.226. PurchasePointsResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.227. RaveAccountPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.228. ReasonForIssuance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.229. RefundPaymentAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.230. RefundPriceOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.231. ReissueRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.232. RequiredPointsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.233. RequiredPointsResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.234. Reservation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.235. RetrieveBookingRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.236. RetrieveCreditCardPaymentOptionsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.237. RetrieveCreditCardPaymentOptionsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.238. RetrieveLoyaltyRedemptionPaymentOptionsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.239. RetrieveLoyaltyRedemptionPaymentOptionsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.240. RetrievePaymentOptionsRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.241. RetrievePaymentOptionsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.242. RetrievePaymentResultRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.243. SSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.244. SadadPaymentDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
3.245. Seat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
3.246. SeatDisallowedAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.247. SeatDisallowedPerPassenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.248. SeatGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.249. SeatMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.250. SeatMapCabin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
3.251. SeatMapColumn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
3.252. SeatMapPart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
3.253. SeatMapRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
3.254. SeatMapSeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
3.255. Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
3.256. SecuredAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
3.257. Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
3.258. SegmentAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
3.259. SegmentPassenger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
3.260. SendPinViaEmailRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
3.261. SimpleCompany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
3.262. SimpleSSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
3.263. SofortDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
3.264. SpecialRequests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.265. SsrModifyRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.266. SsrModifyResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
3.267. StateList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.268. StateType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.269. StopLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.270. SubPackagePrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.271. Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
3.272. ThreeDomainSecurity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
3.273. Ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
3.274. TicketArranger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
3.275. TicketContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
3.276. TicketPassenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
3.277. TicketWithoutPaymentRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
3.278. TierMile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
3.279. TravelInsurance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
3.280. TriggerTwoFactorAuthRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
3.281. TriggerTwoFactorAuthResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
3.282. TurkcellCuzdanDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
3.283. UpdateMemberProfileRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
3.284. UpgradePackagesResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
3.285. VersionResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
3.286. Voucher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
3.287. WarningNotification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
3.288. detailedHealthCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Paxgateway

Chapter 1. Overview
HititCS Crane UI Paxgateway API

1.1. Version information

Version : 1.3.11

1.2. URI scheme

Host : paxgateway.hitit.aero
BasePath : /v1
Schemes : HTTP, HTTPS

1.3. Tags

• auth : Authorization and Authentication Services

• availability : Availability Services

• cache : Cache Services

• checkin : Check-In Services

• common : Common Data Retrival Services

• flight : Flight Schedule Services

• healthCheck : Health Check Services

• insurance : Insurance Services

• invoice : Invoice Services

• loyalty : Loyalty Services

• payment : Payment Services

• reservation : Reservation Services

• ssr : SSR Services

• ticketing : Ticketing Services

This document is a guide for HititCS Pax Gateway services.

Paxgateway Confidential Page:1/344

Paxgateway

1.4. Conversation

Since the application is an "API Gateway" application, session management is not being used.
Additionally, "conversation" management is implemented in the application instead of send data to
the user and ask the user to send it again, in order to make the API more plain. Memory
management performance is improved by deleting the generated data in the "conversation" when
it is invalid for the process. In addition, services that are completely stateless, such as portMatrix,
are excluded from conversation management, improving resource management performance.

A conversation starts by calling the availability or booking/retrieve service. When the availability or
booking/retrieve is called, a "header" is returned as response, in the name of "X-Conversation-
Token". This header should be added to the request message in the service calls of the end of the
ticket process.

There are two levels of conversation. After booking/retrieve or availability, conversations are
moved to second level in order to improve lifespan.

1.5. API Key Usage

API key is a secret token which is submitted alongside web service (or similar) requests in order to
identify the origin of the request. API key can be used in two ways.

1.5.1. Parameter

https://paxgateway.hititcs.com.tr/definitions/ports?key=123

1.5.2. Request HTTP Header

X-Key:123

1.6. Date Formats

The date format to be used in queries:

Date: dd.MM.yyyy

Date/Time: dd.MM.yyyy HH:mm:ss

Paxgateway Confidential Page:2/344

Paxgateway

1.7. Client IP

Client IP can be send by setting IP into X-CLIENT-IP header. If header does not exist, source IP will be
used as client IP.

1.8. Version Check

Version check is being performed for every service call. Requires the "X-CLIENT-VERSION" header.
Skips if header is not sent or returns an unknown value.

1.8.1. Format

X-CLIENT-VERSION: {os}-{version}

1.8.2. Example

X-CLIENT-VERSION: ios-3.0.5

1.9. Currency

Paxgateway sets the preferred currency after availability request. Currency is overridable with "X-
CURRENCY" header on any stage.

1.9.1. Format

X-CURRENCY: {currency}

1.9.2. Example

X-CURRENCY: TRY

1.10. Accept-Language

Paxgateway is support the "Accept-Language" standard header type. Paxgateway sets the preffered
language for every service call with using this http header.

1.10.1. Format

Accept-Language: {lang};{q-value}

Paxgateway Confidential Page:3/344

Paxgateway

1.10.2. Example

Accept-Language: en-US;q=0.7,en;q=0.3

1.11. Health Check Services

Detailed Health Check (/detailedHealthCheck) and BL (/blHealthCheck) and Sapay

(/sapayHealthChek) health check services determines whether these services are working properly
by sending a request to the relevant services.
These services require valid token in the 'X-Editor-Token' header to send successful response.
This token can be acquired via /auth/authenticateEditor endpoint.

1.12. Procedure Diagrams

Paxgateway Confidential Page:4/344

Paxgateway

Reservation Procedure

Client Paxgateway

POST /availability

Conversation started

List<Journey>

POST /extraCharges

List<ExtraCharges>

POST /booking/create

Booking

POST /booking/passengers

200/OK

GET /ssrs/{bookingId}

List<AvailableSsrs>

GET /ssrs/{bookingId}/seatMap/{segmentId}

List<SeatMap>

POST /ssrs/${bookingId}

SsrModifyResponse

POST /payment/options

RetrievePaymentOptionsResponse

POST /payment/creditCardOptions

RetrieveCreditCardPaymentOptionsResponse

POST /payment/authorize

AuthorizePaymentResponse

POST /payment/authorizeAfterRedirect

AuthorizePaymentResponse

ConfirmPurchase

Success

Paxgateway Confidential Page:5/344

Paxgateway

Reissue Prodecure

Client Paxgateway

POST /booking/retrieve

Conversation started

Booking

POST /availability (reissue:true)

List<Journey>

POST /extraCharges

List<ExtraCharges>

POST /booking/reissue (purpose:CALCULATE)

Booking

POST /booking/reissue (purpose:PERSIST)

Booking

GET /ssrs/{bookingId}

List<AvailableSsrs>

POST /ssrs/${bookingId}

SsrModifyResponse

If modification amount > 0

POST /payment/options

RetrievePaymentOptionsResponse

POST /payment/creditCardOptions

RetrieveCreditCardPaymentOptionsResponse

POST /payment/authorize

AuthorizePaymentResponse

POST /payment/authorizeAfterRedirect

AuthorizePaymentResponse

ConfirmPurchase

Success

End if

Paxgateway Confidential Page:6/344

Paxgateway

Checkin Prodecure

Client Paxgateway

POST /booking/retrieve

Conversation started

Booking

GET /checkin/availableFlights

List<Segment>

GET /checkin/availablePassengers/${segmentId}

if apisRequired = false

POST /checkin/retrieveApisFields

List<ApisField>

end if

List<PassengerDcsInformation>

if !specialRequests.contains("SEAT")

POST /checkin/expectedSeats

List<ExpectedSeats>

/ssr/*

/ssr/*

end if

POST /checkin/perform

CheckInResponse

1.13. List of Response Error Codes

Errors from Crane services are returned directly. ex:

Paxgateway Confidential Page:7/344

Paxgateway

{
"source": "ERRCRANE",
"detail": {
"args": [
],
"error": "AVAILABILITY_ERR_AVAIL_ADLT_INFNT_COUNT_MISMATCH",
"message": "Infants can not be more than adults"
},
"error": "AVAILABILITY_ERR_AVAIL_ADLT_INFNT_COUNT_MISMATCH",
"message": "Infants can not be more than adults"
}

Errors from Sapay services are returned directly. ex:

{
"source": "ERRSAPAY",
"error": "ERR_P24",
"message": "Please specify correct payment option"
}

Errors from Gateway services are returned with code and explanation message. ex:

{
"source": "ERRGATEWAY",
"error": "ERR004",
"message": "Unexpected character ('}' (code 125)): expected a value"
}

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR001 401 Api key verification error All Provided api key doesn’t
exist in the properties
file.

ERR002 426 MUST_UPDATE All Client version provided

in X-Client-Version is no
longer supported.

Paxgateway Confidential Page:8/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR003 400 Provided /version/{os}/{appVersio Provided os/appVersion

{os}/{appVersion} n} combination isn’t
combination doesn’t present in the
exist configuration.

ERR004 400 Can’t construct instance All Field specified in the

of {field} from '{value}' error message can’t be
parsed.

ERR005 400 Could not find X- All expect Conversation token

Conversation-Token /booking/retrieve and header is invalid or not
header or conversation is /availability present.
invalid

ERR006 412 Conversational All expect Can’t get the requested

precondition exception /booking/retrieve and object from
/availability conversation.

ERR007 400 List of: {field} must no be All Fields specified in the
{null|empty} error message are
required fields.

ERR008 401 Invalid credentials /auth/authenticateUser Login information is

incorrect.

ERR009 400 X-Loyalty-Token must be All of the /lms/* services Loyalty token header is
present not present.

ERR010 401 X-Loyalty-Token has All of the /lms/* services Loyalty token header has
expired expired and no longer
valid.

ERR011 400 X-Loyalty-Token is invalid All of the /lms/* services X-Loyalty-Token is

malformed.

Paxgateway Confidential Page:9/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR012 401 Passenger count fields /availability

should be undefined or 0
for reissue requests

ERR013 404 Data Not Found /translations and Unable to read config
/options file.

ERR014 406 Not allowed in reissue /booking/passengers

process

ERR015 400 Invalid Request /payment/authorize Return url is required if

return type is "redirect"

ERR016 409 Can’t change currency /booking/create X-Currency header has

during /booking/create been sent in
/booking/create request

ERR017 400 At lease one adult or /availability

child is required.

ERR018 400 This operation is not All of the /ssr/* services, Requested operation is
supported during reissue POST /booking/contacts, not supported during
process POST reissue process, try again
/booking/passengers after finishing the
process.

ERR019 400 Parent id is mandatory /booking/passengers

for infants

ERR020 400 Selected parent is not …

marked as hasInfant =
true

ERR021 401 Member is not activated. If member can’t activate

Paxgateway Confidential Page:10/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR022 401 There is not price If no called

freezing options. /priceFreezingOptions or
/extraCharges

ERR023 401 No option for reference Wrong option number

id found.

ERR024 401 You must fill one of Empty payment options

payment options.

ERR025 401 You need to fill Empty payment options

amountInLocalCurrency.

ERR026 401 You need to fill Empty payment options

ffAmount.

ERR027 401 You need to fill ffPoint. Empty payment options

ERR028 401 You need to fill Empty payment options

totalMiles.

ERR029 401 You need to add key at You need to add key at
least one least one

ERR030 400 You need to fill /booking/newPackages

packageId and
segmentId

ERR031 400 PackageId Not Found /booking/newPackages

ERR032 400 SegmentId Not Found /booking/newPackages

ERR033 500 wallet.properties not /checkin/boardingpassW

found! allet

ERR034 500 Failed to create wallet! /checkin/boardingpassW

allet

Paxgateway Confidential Page:11/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR035 500 No Permission! service permissions

ERR036 500 Can’t complete ticketing! /ticketWithoutPayment

ERR037 500 Wrong Insurance /insurance

PolicyCode!

ERR038 500 taxNumber should be booking/invoice Tax number should not

shorter! be longer than the
defined character limit.

ERR039 500 ReferenceID not found! /extraCharges or Reference id not found in

/booking/create conversation token.

ERR040 500 socialSecurityNo should booking/invoice Social security number

be shorter! should not be longer
than the defined
character limit.

ERR041 500 Name + Surname total booking/invoice Name + Surname length

length must be shorter should not be longer
than the defined
character limit.

ERR042 500 Company Name should booking/invoice Company length should

be shorter! not be longer than the
defined character limit.

ERR043 500 Tax Office should be booking/invoice taxOffice field length

shorter! should not be longer
than the defined
character limit.

Paxgateway Confidential Page:12/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR044 500 Address should be booking/invoice address field length

shorter! should not be longer
than the defined
character limit.

ERR045 500 X-Editor-Token has /cache/clear Probably you trying to

expired clear caches with expired
token

ERR046 500 X-Editor-Token is invalid /cache/clear Probably you trying to

clear caches without
token

ERR047 500 Current member /lms/changeMemberPin currentPin can not

password can’t be blank. allowed empty
characters.

ERR048 500 Check current password. /lms/changeMemberPin currentPin can not match
in the token member
password.

ERR049 500 Encountered an error /lms/changeMemberPin <pinChanged>false</pin

while changing the pin. Changed>

ERR060 400 Currency cannot be /availability Currency cannot be null

empty or empty

ERR061 400 Requested trip type is /cheapestFlights Requested trip type is

not allowed in the not allowed in the
cheapest flights service cheapest flights service

Paxgateway Confidential Page:13/344

Paxgateway

Error Code HTTP Error Message Returned By Explanation

Status
Code

ERR062 400 Not allowed in "reissue", GET Discount operations is

"price freezing" and /booking/availableDiscou not allowed in "reissue",
"stand alone ancillary nts, POST "price freezing" and
sales(SSR)" processes. /booking/discounts, "stand alone ancillary
DELETE sales(SSR)" processes
/booking/discounts

ERR500 500 Unexpected server error All Represents an error that

doesn’t fall into any
other category.

ERRCRANE 502 Crane fault message All Errors returned from

crane services. Example
provided above.

1.14. IOS Wallet Integration

Stages of IOS wallet integration for mobile clients.

To view the detailed official document please visit.

1.14.1. Certificates, images and definitions

• First of all you need to create AppleWWDRCA.cer and PassCertificate.p12

sertificates from IOS services.

• Copy these sertificates to ${CATALINA_HOME}/conf/hititcs/wallet

• Create your logo and icon packages like and copy these images to
${CATALINA_HOME}/conf/hititcs/wallet ; ex

Paxgateway Confidential Page:14/344

Paxgateway

icon.png
icon@2x.png
icon@3x.png
logo.png
logo@2x.png
logo@3x.png
tsa.png
tsa@2x.png
tsa@3x.png
ssss.png
ssss@2x.png
ssss@3x.png

After these operations you’re almost ready.

1.14.2. Customize and configure your ticket.

By default, the iOS wallet offers a ticket design that cannot be changed much.

You can change properties such as background color, font color, label color.
In your wallet.properties from
${CATALINA_HOME}/conf/hititcs/wallet.properties ex

ios.wallet.background=#235CA9
ios.wallet.foreground=#ffffff
ios.wallet.labelcolor=#AA9113

Important: You can create multiple language support in the wallet service(Must be ISO 639-1
format). ex
For example, If you want to turkish language support;
# Copy wallet.properties and paste same directory with rename wallet-
tr.properties
# Change property labels text in your language

You MUST change the PassIdentifier,TeamIdentifier,Certificate Password, Organization Name fields

depending on your sertificates. ex

Paxgateway Confidential Page:15/344

Paxgateway

ios.wallet.passTypeIdentifier=pass.com.hititcs.hcs //must be start with

pass.com
ios.wallet.teamIdentifier=ZRH7YN6RZ6
ios.wallet.certificate.password=1234
ios.wallet.organizationName=Hitit Airlines

You can change the date format seen on the ticket. ex

ios.wallet.date.format=dd.MM.yyyy

You can change the barcode format seen on the ticket. ex

ios.wallet.barcode.format=PKBarcodeFormatAztec

You can decide the wallet back fields should seen/not seen. ex

ios.wallet.backfield.terms.allowed=false

You can change the static label fields that appear on the ticket. ex

Paxgateway Confidential Page:16/344

Paxgateway

ios.wallet.header.label.gate=GATE
ios.wallet.header.changeText.gate=Boarding time changed to %@.

ios.wallet.primary.changeText.depart=Origin changed to %@.

ios.wallet.primary.changeText.arrive=Destination changed to %@.

ios.wallet.secondary.label.passengerName=PASSENGER NAME
ios.wallet.secondary.changeText.passengerName=Passenger changed to %@.

ios.wallet.secondary.label.seq=SEQ
ios.wallet.secondary.changeText.seq=Sequence changed to %@.

ios.wallet.auxiliary.label.date=DATE
ios.wallet.auxiliary.changeText.date=Date changed to %@.

ios.wallet.auxiliary.label.depart=DEPART
ios.wallet.auxiliary.changeText.depart=Boarding time changed to %@.

ios.wallet.auxiliary.label.flight=FLIGHT
ios.wallet.auxiliary.changeText.flight=Flight number changed to %@

ios.wallet.auxiliary.label.seat=SEAT
ios.wallet.auxiliary.changeText.seat=Seat changed to %@

ios.wallet.backfield.label.terms=Terms and Conditions for Online Check-

in
ios.wallet.backfield.content.terms=Lorem ipsum dolor sit amet,
consectetur adipiscing elit.

1.14.3. Who send certificates/images/definitions?

What should mobile developers send?

• PassCertificate.p12 file and password this certificate

• The definitions below:

ios.wallet.teamIdentifier: 1111111111
ios.wallet.organizationName: HITITCS
ios.wallet.passTypeIdentifier: pass.com.hititcs.hcs

Note: For the detail information about create certificate you should read this documentation

What should UI/UX designers send?

• Logo that will appear on the ticket.(with different three size)

Paxgateway Confidential Page:17/344

Paxgateway

logo.png
logo@2x.png
logo@3x.png

• Icon that will appear on the mail and notification.(with different three size)

icon.png
icon@2x.png
icon@3x.png

• Image that will appear above the barcode for TSA Precheck passengers. (with different three
size)

tsa.png
tsa@2x.png
tsa@3x.png

• Image that will appear above the barcode for Secondary Security Screening Selection. (with
different three size)

ssss.png
ssss@2x.png
ssss@3x.png

• Background/Label/Foreground colors

ios.wallet.background=#235CA9
ios.wallet.foreground=#ffffff
ios.wallet.labelcolor=#AA9113

What should deployment teams send?

For the multi language support, deployment team should be add different copies from
wallet.properties and change label text definitions.

wallet-tr.properties // text definitions should be Turkish language

wallet-fr.properties // text definitions should be French language
...

Paxgateway Confidential Page:18/344

Paxgateway

1.14.4. How to Call a Service

With a normal / boardingpass request body, you can send a request to the /
boardingpassWallet endpoint. ex

{
"segmentId": "123456",
"passengerList": [
{
"passengerType": "ADLT",
"id": "1111",
"isElligibleForCheckin": false,
"birthDate": "09.03.2000",
"bookingReferenceID": "ZEE179",
"isChecked": true,
"surname": "YRD",
"givenName": "MRV",
"socialSecurityNo": "23423423421",
"gsm": {
"preferred": false
},
"seatInfo": [
{
"changeReason": "",
"seatNumber": "21L",
"changeType": "",
"seatInRow": "11",
"deckLevel": "",
"rowNumber": 21
}
],
"gender": "F",
"isBoardingCardPrintable": true
}
]
}

*Note: For the multi language support you should add request header Accept-Language
variable must be ISO 639-1 format. ex

Accept-Language: TR
Accept-Language: EN
Accept-Language: FR

The service response will dynamically return a file with the extension {PNR_NAME}.pkpass .
You can handle this file in your IOS code and add it to the wallet. ex

Paxgateway Confidential Page:19/344

Paxgateway

guard let result: Data = entity.content as? Data

1.15. Find Country User From Client IP

PAX user can be override and find the country to which the IP address from the client is connected.

If this feature is desired to be used, the following definition should be true.ex

#Try to change user information with IP country?

country.user.from.ip=true

*Note: Location based definitions in apiKey.properties should be checked.ex

### Location Based Definitions ###

ANDROIDIT=SAMOBILE
InternetNL=SA
InternetNL=SA

This feature uses the embedded "IP Country Database" provided by GeoLite2 services.

Embedded IP Databases receive updates at intervals. Because of that, Pax-gateway should be up-to-
date.

1.15.1. How to update Embedded IP Database?

Via the file with the extension .mmdb located in $ {CATALINA_HOME} / conf / hititcs
/ geolite2-country directory.

You should download by selecting the GeoLite2 Country option from here.

1.16. Book On Hold Payment Type

This payment method ensures that the payment is made asynchronously after the payment order
has been placed and ticketing is made after the payment has been successfully completed.

Paxgateway’s responsibility in this payment method is that it does not automatically go to ticketing
after the payment order has been placed.

The response returned as a result of the book on hold payment; ex

Paxgateway Confidential Page:20/344

Paxgateway

{
"referenceId":"1234567",
"orderId": "CRA59873436",
"status": "BOOK_ON_HOLD",
"ticketTimeLimit": "26.02.2020 14:41:00",
"bookingId": "11F6LR",
"pnrReferenceId":"XXXX"
}

Once this result is returned, payment will be received by another channel with these references.

After the payment process is completed, ticketing flow will start between the payment system
and Crane PAX. Ticketing will be completed in the Crane PAX system.

1.17. JWT(Json Web Token) Encryption

JWT is used in pax-gateway application to produce and transmit loyalty tokens and editor tokens.

RSA public / private keys are used for JWT encryption. RSA (Rivest–Shamir–Adleman) is one of the
first public-key cryptosystems and is widely used for secure data transmission.

1.17.1. How Can Be Create And Sertificate RSA Private/Public Key

First of all you need to create 2048 bits RSA Private/Public Key.
There are many options for this.

We used Online Generator for tests.

Private Key; ex

Paxgateway Confidential Page:21/344

Paxgateway

-----BEGIN RSA PRIVATE KEY-----

MIIEowIBAAKCAQEAomNtiRloLRFcazdY317APw+a7tz2NSHPf421YN25b1yPYfdq
6fE7FcgxBwb1s6Z8EBDlIpk0oc+RBlcDIELB5nGp4PlnH5Tph+9ORsWdNefJ7PoH
te3a5f2l7J0imDC7hi843gKDbaeaF7VpJarip6PA7qNs8QCfD+1zguUGhJ9AtaNn
KVpRPZGmLDXJfGlOPen2UcAm6XeAR1y0CW0MlpAp09PWovAnVdMXs16fr4Ry7U5w
lhsj2bSZ/NzpG1oW88sYSsn/Y/4Frl/jA4ScB5puYnW2uqsd5a7ncNi6jK7rjCGF
A5Kd6LXucAy4M+XNiy+yGf1tqreA3yYebStsLwIDAQABAoIBAFYannP5stFiyTxY
hpk6JnnJjn9lTm9x1BJwU2JfbvnrfGOXy2rsbEXqdoShXhq6BkKGkti7n7rE0sMn
1BKBE0tbrZYK6HFIhmN7sme4VNnGY71x/jCrREx7KEXENBm6jVRjKaYecw3rtrsn
h+9fIvt8yso+gX9wsubBI2Seh8w9wZjyZJlfmiDwiAtu2ln+xEhfNHpNSGSd1SLC
KGFqu8aLlRnVaKbONEvYWUD6+wjAoOyUwJTafVDBZ553Cji9d9BLymyiYNFZC5bR
4ggnCJ3hdoCX/4s+aJsUoAdjRrpA9iaxwuBklSIFgqg5rkb3qqikQmNoGJ/Y5qsX
btYMmcECgYEA8n0KFeonndHhePe3G0V3jEUV6HKVccTlwqwnvdCGLWD4hWmRTffv
OeDHR4B/XYYMjevZwk2zyAkR7cNA1uxmFX1zALSwxexwjeKRs/VXyvDLTsiKyUXj
pPPdP2559JfD0MNgr9c/AqSdK8zMARveoh9K8o88fpG+KVATy5t5I3ECgYEAq2/O
evXDY/yXIvcfNP5I3KlIxOndhtmWVuR7vBIwGtttF/ZBv9gzXjb3xGbhd+mz7+3k
RCDsiU3HddfvMbNeQwtSE091bsalDMVMBN9Iwtl4vHyI5wmt8JoGnb1cta3nWDJ/
m/mwwdWtQeVFw+SMaQVxTRtgj1QEEH9sa9sOeZ8CgYB8B0rOVLs4tO5fwkxs7YYt
P/TptRoNXAmtHgMhynOm6E+VZZ7Fw4ggEYG8Z9Q9kOABA16ZTMclDMaX12PlynqY
iVb2SHWWds5HNFkUM+xYx/sla9vZAR9j8rv6wtYsLighMp3UswLupiYiDhlWg9vH
Drx1/p+RmZgrZ2MIpJg8cQKBgHHKaJcdAXAgfIDs3n3iOqKcinyJbkzPqAZM6gRP
Xja1Zpf9EG8yJgZnHdXzI7zgFlsu39CIuff49Ge3yECI+gwuO3At0ZiRqYPsgSTK
wBT1HDqfvo770cRdt/6DbkH5CBF2k1UIStad6b5PXBtGXBxpTGcNwO3hqkD5ExIT
+GupAoGBAIiTQz6kO19DotP0rIXaKlo4MXPBQSf4fPL/F0OYx47wRttH8vGmQTWI
MsBwYimAgYGGYNkUJB4p5ZxM8raYxfnxtyzNnlYIgx1Ql/eJvXK5B/U+aUmL1bmc
o/a79XCsLQVDIf73Qt0b2E1uFefZWK++7kbfT3tVEK4EBA0R560I
-----END RSA PRIVATE KEY-----

Public Key; ex

-----BEGIN PUBLIC KEY-----

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAomNtiRloLRFcazdY317A
Pw+a7tz2NSHPf421YN25b1yPYfdq6fE7FcgxBwb1s6Z8EBDlIpk0oc+RBlcDIELB
5nGp4PlnH5Tph+9ORsWdNefJ7PoHte3a5f2l7J0imDC7hi843gKDbaeaF7VpJari
p6PA7qNs8QCfD+1zguUGhJ9AtaNnKVpRPZGmLDXJfGlOPen2UcAm6XeAR1y0CW0M
lpAp09PWovAnVdMXs16fr4Ry7U5wlhsj2bSZ/NzpG1oW88sYSsn/Y/4Frl/jA4Sc
B5puYnW2uqsd5a7ncNi6jK7rjCGFA5Kd6LXucAy4M+XNiy+yGf1tqreA3yYebSts
LwIDAQAB
-----END PUBLIC KEY-----

Save both of them(Private Key, Public Key) like private_key_without_ssl.pem and

public_key.pem(with comment lines)

without_ssl suffix is important for private key. You have to sign

this key with OpenSSL sertificate!

Run this command:

Paxgateway Confidential Page:22/344

Paxgateway

openssl pkcs8 -topk8 -inform PEM -in private_key_without_ssl.pem -out

private_key.pem -nocrypt

private_key.pem and public_key.pem must be saved under the JWT folder.

JWT folder must be on the classpath.

1.17.2. Summary

ROOT DIRECTORY on the classpath.

|_ JWT(FOLDER)
|_ private_key.pem(signed private encrypt key file)
|_ public_key.pem(public key file)

1.18. Disable Services Logs

This feature developed for disable certain services endpoint addresses logs. If you want to disable
one or more services REST endpoint and SOAP service’s logs, simply add these endpoint Urls to
logging.ignored.endpoints key seperated by commas.

1.18.1. e.g → logging.ignored.endpoints=/definitions/currencies,

/definitions/languages

Paxgateway Confidential Page:23/344

Paxgateway

Chapter 2. Resources

2.1. Auth

Authorization and Authentication Services

2.1.1. Authenticate Editor for caching operations

POST /auth/authenticateEditor

Description

This service used for log in to the editor system. If credentials given as the request body are correct,
service sends authorization token as X-Editor-Token with response header. This token must be
used to access caching services.

Parameters

Type Name Description Schema

request AuthenticateUserReq
Body request
required uest

Responses

HTTP
Description Schema
Code

Success
200 Headers : No Content
X-Editor-Token (string) : JWT token for caching services.

401 Unauthorized No Content

Consumes

• application/json

Paxgateway Confidential Page:24/344

Paxgateway

Produces

• application/json

2.1.2. Authenticate User for Loyalty Services

POST /auth/authenticateUser

Description

This service used for log in to the member system. If credentials given as the request body are
correct, service sends authorization token as X-Loyalty-Token with response header. This
token must be used to access secure loyalty services.

Parameters

Type Name Description Schema

request AuthenticateUserReq
Body request
required uest

Responses

HTTP
Description Schema
Code

Returns AuthToken on header

200 Headers : MemberProfile
X-Loyalty-Token (string) : JWT token for loyalty services.

401 Unauthorized No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:25/344

Paxgateway

2.2. Availability

Availability Services

2.2.1. Available Flights Search Service

POST /availability

Description

This service used for search available flight list with given request model

Parameters

Type Name Description Schema

body
Body Search criteria AvailabilityRequest
required

Responses

HTTP
Description Schema
Code

<
200 Success / X-Conversation-Token 24f6aebecb44e21b… AvailabilityRespons
eItem > array

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

Usage guide

This service can response several search types with same request and response models.

Paxgateway Confidential Page:26/344

Paxgateway

One Way Trip

For one way trip search, you need to put one flight request object in
AvailibilityRequest.fligthRequestList.

Sample Request

{
"adultCount" : 1,
"currency" : "TRY",
"tripType" : "ONE_WAY",
"flightRequestList" : [
{
"depPort" : "SWT",
"arrPort" : "ADA",
"date": "2018-11-23"
}
]
}

And as a result, response will contain only one Journey object.

Sample Response

[
{
"journeyType": "OUTBOUND",
"days" : [
{
"date": "2018-11-22",
...
},
{
"date": "2018-11-23",
...
},
{
"date": "2018-11-24",
...
}
]
}
]

 dateOffset default value is 1 so result will contains tree JourneyDay object.

Paxgateway Confidential Page:27/344

Paxgateway

Round Trip

For round trip search, you need to put two flight request object in
AvailibilityRequest.fligthRequestList. Departure port of the first flight must be
same with arrival port of the second flight and arrival port of the first flight must be same with
departure port of the second flight.

Sample Request

{
"adultCount" : 1,
"currency" : "TRY",
"tripType" : "ROUND_TRIP",
"flightRequestList" : [
{
"depPort" : "SWT",
"arrPort" : "ADA",
"date": "2018-11-23"
},
{
"depPort" : "ADA",
"arrPort" : "SWT",
"date": "2018-11-24"
}

]
}

And as a result, response will contains two Journey object.

Paxgateway Confidential Page:28/344

Paxgateway

Sample Response

[
{
"journeyType": "OUTBOUND",
"days" : [
{
"date": "2018-11-22",
...
},
{
"date": "2018-11-23",
...
},
{
"date": "2018-11-24",
...
}
]
},
{
"journeyType": "INBOUND",
"days" : [
{
"date": "2018-11-23",
...
},
{
"date": "2018-11-24",
...
},
{
"date": "2018-11-25",
...
}
]
}
]

Reissue

In reissue process passenger list cannot be modified. Because of this reason reissue requests cannot
passenger count fields should be undefined or 0

Paxgateway Confidential Page:29/344

Paxgateway

Sample Request

{
"reissue" : true,
"currency" : "TRY",
"tripType" : "ROUND_TRIP",
"flightRequestList" : [
{
"depPort" : "SWT",
"arrPort" : "ADA",
"date": "2018-11-23"
},
{
"depPort" : "ADA",
"arrPort" : "SWT",
"date": "2018-11-24"
}

]
}

2.2.2. Available Cheapest Flights Search Service

POST /cheapestFlights

Description

This service used for check cheapest flights montly

Parameters

Type Name Description Schema

body CheapestFlightsRequ
Body Search criteria
required est

Responses

HTTP
Description Schema
Code

<
200 Success / X-Conversation-Token 24f6aebecb44e21b… CheapestFlightsRes
ponse > array

Paxgateway Confidential Page:30/344

Paxgateway

HTTP
Description Schema
Code

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.2.3. Extra Charges Information Service

POST /extraCharges

Description

This service used for get information and options for selected flight(s) fare id list

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body
Body Fare referance ids < string > array
required

Responses

HTTP
Description Schema
Code

< ExtraCharges >

200 Success
array

Paxgateway Confidential Page:31/344

Paxgateway

HTTP
Description Schema
Code

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.3. Cache

Cache Services

2.3.1. Clear pax-gateway caches

GET /cache/clear

Description

This service used for clear the application’s cache. If the onlyCurrentNode request parameter is
set to true, caches are cleared on all nodes, otherwise only the current node’s cache is cleared

Parameters

Type Name Schema

apiKey
Header string
required

x-editor-token
Header string
required

Responses

Paxgateway Confidential Page:32/344

Paxgateway

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.3.2. Refresh PAX cache’s

GET /cache/refreshSystemCache

Parameters

Type Name Schema

x-editor-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

Paxgateway Confidential Page:33/344

Paxgateway

2.4. Checkin

Check-In Services

2.4.1. Retrieves available flights for check-in

GET /checkin/availableFlights

Description

This service used for get available flights for check-in in booking and returns Segment list for
available flights.
For the segments whose freeSeating attribute is true:
- Seat selection is not available for check-in.
- Seat number is not used in the check-in request and has the value OPEN in the response.
- '/checkin/expectedSeats' and '/ssrs/seatMap' endpoints should not be called in the check-in flow.

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success < Segment > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

Paxgateway Confidential Page:34/344

Paxgateway

2.4.2. Get Passenger(s) For Checkin

GET /checkin/availablePassengers/{segmentId}

Description

This service used for get available passenger(s) for check-in in segment given as path variable.
For the passengers whose freeSeating attribute is true:
- Seat selection is not available for check-in.
- Seat number is not used in the check-in request and has the value OPEN in the response.
- '/checkin/expectedSeats' and '/ssrs/seatMap' endpoints should not be called in the check-in flow.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

segmentId
Path segmentId string
required

Responses

HTTP
Description Schema
Code

<
200 Success PassengerDcsInfor
mation > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Paxgateway Confidential Page:35/344

Paxgateway

Produces

• application/json

2.4.3. boardingpass with segmentId and passengerList

POST /checkin/boardingpass

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request BoardingCardReques
Body request
required t

Responses

HTTP
Description Schema
Code

< BoardingCard >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.4.4. boarding pass for ios wallet integration

POST /checkin/boardingpassWallet

Paxgateway Confidential Page:36/344

Paxgateway

Parameters

Type Name Description Schema

Accept-
Header Language string
optional

request BoardingCardReques
Body request
required t

Responses

HTTP
Description Schema
Code

200 Success string (byte)

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

2.4.5. Gets boarding pass with passengerHashValue

GET /checkin/boardingpassWithKey

Parameters

Type Name Description Schema

Passenger hash values - always brings only 1

ch
Query boarding pass.Example use -> < string > array
optional
/boardingPassWithKey?ch=123&ch=456

includeIatci If true, response will contain boarding cards for

Query boolean
optional iatci check-ins. Default "false"

Paxgateway Confidential Page:37/344

Paxgateway

Responses

HTTP
Description Schema
Code

< BoardingCard >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.4.6. Cancel check-in

POST /checkin/cancel

Description

This service used for cancel check-in for selected passengers in given flight’s segment id.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request CancelCheckInReque
Body request
required st

Responses

Paxgateway Confidential Page:38/344

Paxgateway

HTTP
Description Schema
Code

<
200 Success CancelCheckInResp
onse > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.4.7. Gets expected seats for passengers

POST /checkin/expectedSeats/{segmentId}

Description

This service used for automatic seat selection for check-in with given passengers in segment given
as path variable.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

segmentId
Path segmentId string
required

Paxgateway Confidential Page:39/344

Paxgateway

Type Name Description Schema

<
request
Body request PassengerDcsInform
required
ation > array

Responses

HTTP
Description Schema
Code

<
200 Success PassengerSeatInfor
mation > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.4.8. Available Arrival Ports For Kiosks

GET /checkin/kioskArrivalPorts

Description

Get available arrival ports for kiosks(Response’s only work for KIOSK users)

Parameters

Paxgateway Confidential Page:40/344

Paxgateway

Type Name Description Schema

arrPort Filter response with arrival port code | Example :

Query string
optional IST

cityCode
Query Filter response with city code | Example : IST string
optional

countryCode
Query Filter response with country code | Example : TR string
optional

isDomestic Filter response with domestic or international

Query boolean
optional flights | Example : true

Responses

HTTP
Description Schema
Code

<
200 Success KioskArrivalPortsR
esponse > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.4.9. Available Flights For Kiosks

GET /checkin/kioskAvailableFlights

Description

Returns all flights suitable for kiosk check-in from the port with the relevant kiosk user.
For the segments whose freeSeating attribute is true:

Paxgateway Confidential Page:41/344

Paxgateway

- Seat selection is not available for check-in.

- Seat number is not used in the check-in request and has the value OPEN in the response.
- '/checkin/expectedSeats' and '/ssrs/seatMap' endpoints should not be called in the check-in flow.

Parameters

Type Name Description Schema

arrPort Filter response with arrival port code | Example :

Query string
optional IST

bookingId
Query Filter response with PNR | Example : B18ABC string
optional

Responses

HTTP
Description Schema
Code

200 Success / X-Conversation-Token 24f6aebecb44e21b… < Segment > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.4.10. Available Passengers For Kiosks

POST /checkin/kioskAvailablePassengers

Description

Returns all Passengers suitable for kiosk check-in.

For the passengers whose freeSeating attribute is true:
- Seat selection is not available for check-in.
- Seat number is not used in the check-in request and has the value OPEN in the response.

Paxgateway Confidential Page:42/344

Paxgateway

- '/checkin/expectedSeats' and '/ssrs/seatMap' endpoints should not be called in the check-in flow.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request KioskAvailablePassen
Body request
required gersRequest

Responses

HTTP
Description Schema
Code

<
200 Success PassengerDcsInfor
mation > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.4.11. Performs check-in

POST /checkin/perform

Description

This service used for finish check-in processes and get check-in for flight(s). Your check-in will be
created after this service executed

Paxgateway Confidential Page:43/344

Paxgateway

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request
Body request CheckInRequest
required

Responses

HTTP
Description Schema
Code

200 Success CheckInResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.4.12. Get Apis Information

POST /checkin/retrieveApisFields

Parameters

Paxgateway Confidential Page:44/344

Paxgateway

Type Name Description Schema

x-conversation-
Header token string
required

segmentId
Body request ApisRequest
optional

Responses

HTTP
Description Schema
Code

< ApisResponse >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.4.13. Sends boarding pass

POST /checkin/sendBoardingPass

Parameters

Paxgateway Confidential Page:45/344

Paxgateway

Type Name Description Schema

x-conversation-
Header token string
required

request BoardingCardReques
Body request
required t

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.5. Common

Common Data Retrival Services

2.5.1. Age Limits

GET /definitions/ageLimits

Description

This service used for retrieve age limits with passengerType list.

Responses

Paxgateway Confidential Page:46/344

Paxgateway

HTTP
Description Schema
Code

<
200 Success AgeLimitResponse
> array

Produces

• application/json

2.5.2. Cabin types

GET /definitions/cabinTypes

Description

This service used for retrieve supported cabin types by airline

Responses

HTTP
Description Schema
Code

200 Success < string > array

Produces

• application/json

2.5.3. Retrieve Known City Names

GET /definitions/cityNames/{lang}

Description

This service used for retrieve known city codes and names by language given as path variable. This
is a special translation service for cities to be flown.

Paxgateway Confidential Page:47/344

Paxgateway

Parameters

Type Name Description Schema

lang
Path Requested language like "tr","en" string
required

Responses

HTTP
Description Schema
Code

< string, string >

200 Success
map

404 Resource Not Found No Content

Consumes

• application/json

Produces

• application/json

2.5.4. Supported Currencies

GET /definitions/currencies

Description

This service used for get supported currency codes and double digit info.

Responses

HTTP
Description Schema
Code

200 Success Currencies

Paxgateway Confidential Page:48/344

Paxgateway

Produces

• application/json

2.5.5. Supported Languages

GET /definitions/languages

Description

This service used for get supported languages, default language codes and names

Responses

HTTP
Description Schema
Code

200 Success Languages

Produces

• application/json

2.5.6. Retrieve Name Title Options

GET /definitions/nameTitle

Description

This service used for get name title options for passengers

Responses

HTTP
Description Schema
Code

200 Success < string > array

Produces

Paxgateway Confidential Page:49/344

Paxgateway

• application/json

Example HTTP response

Response 200

[ "Mr", "Ms" ]

2.5.7. General parameters

GET /definitions/parameters

Description

This service include 'cabinTypes','tripTypes','ageLimits','languages','currencies','nameTitle'

services.This means that combination of the majority definitions service.

Responses

HTTP
Description Schema
Code

GeneralParameter
200 Success
s

Produces

• application/json

2.5.8. Known Airport Matrix

GET /definitions/portMatrix

Description

This service used for retrieve known airport matrix list by airline

Responses

Paxgateway Confidential Page:50/344

Paxgateway

HTTP
Description Schema
Code

< PortMatrix >

200 Success
array

Produces

• application/json

2.5.9. Known Airport Matrix (filtered)

GET /definitions/portMatrix/{segmentType}

Description

This service used for retrieve known airport matrix list filtered by segment type given as path
variable

Parameters

Type Name Description Schema

segmentType enum (DIRECT,

Path Requested segment type
required CONNECTED)

Responses

HTTP
Description Schema
Code

< PortMatrix >

200 Success
array

404 Resource Not Found ErrorResponse

Consumes

• application/json

Paxgateway Confidential Page:51/344

Paxgateway

Produces

• application/json

2.5.10. Retrieve Known Airport Names

GET /definitions/portNames/{lang}

Description

This service used for retrieve known airport codes and names by language given as path variable.
This is a transtation service for airport data.

Parameters

Type Name Description Schema

lang
Path Requested language like "tr","en" string
required

Responses

HTTP
Description Schema
Code

< string, string >

200 Success
map

404 Resource Not Found No Content

Consumes

• application/json

Produces

• application/json

2.5.11. Known Airport List

Paxgateway Confidential Page:52/344

Paxgateway

GET /definitions/ports

Description

This service used for retrieve known airport list by airline

Responses

HTTP
Description Schema
Code

200 Success < Port > array

Produces

• application/json

2.5.12. Get Ports Of Countries

GET /definitions/portsOfCountry

Description

This service used for get state, city and port informations of countries

Parameters

Type Name Description Schema

cityCode Port etc. in the given state information will be

Query string
optional returned. | Example : IST

countryCode State, city, port etc. for the given country

Query string
optional informations will be returned | Example : US

getCityList Only the Country + State + City list will return

Query string
optional without port informations. | Example : false

getCountryList Only Country list will return without State, City,

Query boolean
optional Port informations | Example : false

Paxgateway Confidential Page:53/344

Paxgateway

Type Name Description Schema

getStateList Return only the Country + State list without Port

Query string
optional and City informations | Example : false

includePortList include port list the response default is true |

Query string
optional Example : false

stateCode City, port etc. in the given state information will

Query string
optional be returned. | Example : AK

Responses

HTTP
Description Schema
Code

< CountryInfo >

200 Success
array

Produces

• application/json

2.5.13. Trip Types

GET /definitions/tripTypes

Description

This service used for retrieve supported trip types by airline

Responses

Paxgateway Confidential Page:54/344

Paxgateway

HTTP
Description Schema
Code

< enum
(ONE_WAY,
ROUND_TRIP,
INBOUND_OPEN,
MULTI_DIRECTION
200 Success AL,
OUTBOUND_OPEN
,
INBOUND_OUTBO
UND_OPEN) >
array

Produces

• application/json

2.5.14. Retrieve Options

GET /options

Description

Generic configuration info. Client configuratins can be managed by using this service. This is an
optional feature.

Responses

HTTP
Description Schema
Code

200 Result is a key=value text file ( properties ) No Content

Produces

Paxgateway Confidential Page:55/344

Paxgateway

• text/plain

2.5.15. Translations resource service.

GET /translations/{resource}/{lang}

Description

Translation files can be served by using this service. This is an optional feature.

Parameters

Type Name Description Schema

This is standard http header which determines

Accept
Header the response mime type. Only text/plain and string
optional
application/json allowed.

lang
Path Requested language ISO Code string
required

resource
Path Resource bundle name string
required

This parameter is only applicable for Accept:

list application/json. If true response json will be list
Query boolean
optional of CodeValuePair, otherwise service returns json
object

Responses

HTTP
Description Schema
Code

200 Standard properties file or its json equivalents. string

404 Resource Not Found ErrorResponse

Paxgateway Confidential Page:56/344

Paxgateway

Produces

• text/plain

Usage guide

Related resources are reserved for this service.

portNames

Returns a list of airport codes and names.

Sample Request

/translations/portNames/en

Sample Response

{
"ESK":"Eskisehir Air Base",
"ESH":"Shoreham Airport",
"ESF":"Esler Regional Airport",
"ESE":"Ensenada Airport",
"ESD":"Orcas Island Airport",
"ESC":"Delta County Airport",
"ESB":"Esenboga International Airport"
}

Sample Request

/translations/portNames/en?list=true

Paxgateway Confidential Page:57/344

Paxgateway

Sample Response

[
{
"code": "SXF",
"value": "Berlin Schoenefeld Apt"
},
{
"code": "DRS",
"value": "Dresden"
},
{
"code": "TXL",
"value": "Berlin Tegel Apt"
},
{
"code": "RLG",
"value": "Rostock"
},
{
"code": "BJV",
"value": "Bodrum Milas Airport"
}
]

currencies

Returns currency translations.

Sample Request

/translations/currencies/en

Sample Response

{"TRY":"TL"}

2.5.16. Client Version Control Service

GET /version/{os}/{appVersion}

Parameters

Paxgateway Confidential Page:58/344

Paxgateway

Type Name Description Schema

appVersion
Path Client Application version string
required

os
Path OS Name ( iOS, Android etc ) string
required

Responses

HTTP
Description Schema
Code

If supported os and application version returns status message with

200 VersionResponse
upgrade information.

415 If not supported os and/or application version ErrorResponse

Produces

• application/json

2.6. Flight

Flight Schedule Services

2.6.1. FlightSchedule Service

POST /flight/schedule

Parameters

Type Name Description Schema

request FlightScheduleReque
Body request
required st

Responses

Paxgateway Confidential Page:59/344

Paxgateway

HTTP
Description Schema
Code

FlightScheduleRes
200 Success
ponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.6.2. Flight status by flight number

POST /flight/statusByNumber

Parameters

Type Name Description Schema

request FlightStatusByNumbe
Body request
required rRequest

Responses

HTTP
Description Schema
Code

FlightStatusRespon
200 Success
se

401 Unauthorized No Content

Paxgateway Confidential Page:60/344

Paxgateway

HTTP
Description Schema
Code

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.6.3. Flight status by airport

POST /flight/statusByPort

Description

This service used for

Parameters

Type Name Description Schema

request FlightStatusByPortRe
Body request
required quest

Responses

HTTP
Description Schema
Code

FlightStatusRespon
200 Success
se

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:61/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.7. HealthCheck

Health Check Services

2.7.1. BL Health Check Service

GET /blHealthCheck

Parameters

Type Name Schema

x-editor-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Paxgateway Confidential Page:62/344

Paxgateway

Produces

• application/json

2.7.2. Detailed health check

GET /detailedHealthCheck

Parameters

Type Name Schema

x-editor-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Success detailedHealthChe
ck > array

Produces

• application/json

2.7.3. Pax Gateway Health Check Service

GET /healthCheck

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

Paxgateway Confidential Page:63/344

Paxgateway

HTTP
Description Schema
Code

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.7.4. Payment Service (Sapay) Health Check

GET /sapayHealthCheck

Parameters

Type Name Schema

x-editor-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.8. Insurance

Insurance Services

Paxgateway Confidential Page:64/344

Paxgateway

2.8.1. Add Insurance

POST /insurance

Description

This service used for add available insurance to passenger(s) at booking.

Usage Tips:
- Insurance informations are stored in the conversation token. If the token is updated then all of
this information will be lost while using POST /insurance Service, so you should resend your
request.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request AddInsuranceReques
Body request
required t

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

Paxgateway Confidential Page:65/344

Paxgateway

• application/json

Produces

• application/json

2.8.2. Get Available Insurances

GET /insurance

Description

This service used for get available insurance types and prices at the airline

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

< InsuranceDetail >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

Paxgateway Confidential Page:66/344

Paxgateway

• application/json

2.8.3. Delete Insurance

DELETE /insurance

Description

This service used to delete the insurance added to the existing passengers in booking.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request DeleteInsuranceRequ
Body request
required est

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Paxgateway Confidential Page:67/344

Paxgateway

Produces

• application/json

2.9. Invoice

Invoice Services

2.9.1. Login for invoice services

POST /invoice/login

Parameters

Type Name Description Schema

request
Body request InvoiceLoginRequest
required

Responses

HTTP
Description Schema
Code

InvoiceLoginRespo
200 Success
nse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:68/344

Paxgateway

2.9.2. Logout for invoice services

POST /invoice/logout

Parameters

Type Name Description Schema

sessionId
Body sessionId string
required

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.9.3. View for invoice services

POST /invoice/view

Parameters

Paxgateway Confidential Page:69/344

Paxgateway

Type Name Description Schema

request
Body request InvoiceViewRequest
required

Responses

HTTP
Description Schema
Code

InvoiceViewRespo
200 Success
nse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10. Loyalty

Loyalty Services

2.10.1. Activates membership

GET /lms/activateMember/{activationCode}

Description

This service used for activate inactive membership with activation code given as path variable. If
member activated, service sends authorization token as X-Loyalty-Token with response
header. This token must be used to access secure loyalty services.

Paxgateway Confidential Page:70/344

Paxgateway

Parameters

Type Name Description Schema

activationCode
Path Member activation code string
required

Responses

HTTP
Description Schema
Code

Success
200 Headers : No Content
X-Loyalty-Token (string) : JWT token for loyalty services.

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.2. Retrieve available loyalty partners

GET /lms/availableLoyaltyPartner

Description

This service used for retrieves available loyalty partner companies for authorized member

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Paxgateway Confidential Page:71/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Success < Company > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.3. Change member pin

POST /lms/changeMemberPin

Description

This service used for change member pin/password with new ones. currentPin and newPin
fields can not be same or empty. After succesful pin change, service sends the authorization token
as X-Loyalty-Token with the response header.

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

request ChangeMemberPinR
Body request
required equest

Responses

Paxgateway Confidential Page:72/344

Paxgateway

HTTP
Description Schema
Code

Success
200 Headers : No Content
X-Loyalty-Token (string) : JWT token for loyalty services.

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.4. Get city list with country code

GET /lms/cityList/{countryCode}

Description

This service used for retrieve city list with country code given as path variable.

Parameters

Type Name Description Schema

countryCode two-letter country code (ISO alpha-2) Example;

Path string
required US, TR ,PK

Responses

Paxgateway Confidential Page:73/344

Paxgateway

HTTP
Description Schema
Code

200 Success < City > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.5. Claim reward miles

POST /lms/claimRewardMiles

Description

This service used for claims additional rewards miles. Service does not return any response body.

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

request ClaimRewardMilesRe
Body request
required quest

Responses

Paxgateway Confidential Page:74/344

Paxgateway

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.6. Enroll Member

POST /lms/enrollMember

Parameters

Type Name Description Schema

request EnrollMemberReque
Body request
required st

Responses

HTTP
Description Schema
Code

EnrollMemberResp
200 Success
onse

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:75/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.7. Retrieve expected earned miles

POST /lms/expectedEarnedMiles

Description

This service used for retrieve expected to be earned miles for selected flight’s fare with package

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

<
request
Body request BookingRequestItem
required
> array

Responses

HTTP
Description Schema
Code

ExpectedEarnedMi
200 Success
lesResponse

Paxgateway Confidential Page:76/344

Paxgateway

HTTP
Description Schema
Code

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.8. Retrieve Member Card Information

GET /lms/memberCardData

Description

This service used for retrieve member card information that saved before

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Responses

HTTP
Description Schema
Code

MemberCardDataR
200 Success
esponse

401 Unauthorized No Content

Paxgateway Confidential Page:77/344

Paxgateway

HTTP
Description Schema
Code

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.9. Retrieve Member Miles Sale Attributes

GET /lms/memberMilesSaleAttributes

Description

This service used for retrieve miles details that current member has

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Responses

HTTP
Description Schema
Code

< MilesPrice >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:78/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Produces

• application/json

2.10.10. Retrieve Member Miles To Be Expired

GET /lms/memberMilesToBeExpired

Description

This service used for retrieve miles to be expired list thats current member has

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Success MilesToBeExpired
> array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Paxgateway Confidential Page:79/344

Paxgateway

Produces

• application/json

2.10.11. Retrieve Member Statement

GET /lms/memberStatement

Description

This service used for retrieve member statement list.

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Success MemberStatement
> array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.12. Retrieve Member Statement Details

GET /lms/memberStatementDetail/{statementRefId}

Paxgateway Confidential Page:80/344

Paxgateway

Description

This service used for retrieve member statement details by given statement reference id as path
variable.

Parameters

Type Name Schema

x-loyalty-token
Header string
required

statementRefId
Path string
required

Responses

HTTP
Description Schema
Code

<
200 Success MemberStatement
Detail > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.13. Retrieve Member Transaction List

POST /lms/memberTransactionList

Paxgateway Confidential Page:81/344

Paxgateway

Description

This service used for retrieve member transaction list with given date range. In request body fields
start and end fields must be date format (dd.MM.yyyy)

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

request MemberTransactionL
Body request
required istRequest

Responses

HTTP
Description Schema
Code

<
200 Success MemberTransactio
n > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.14. Retrieve Personal Information Definitions

GET /lms/personalInfoDefinition

Paxgateway Confidential Page:82/344

Paxgateway

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Success MemberPersonalIn
fo > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.15. Retrieve profile

GET /lms/profile

Description

This service used for retrieve authorized member profile information

Parameters

Type Name Schema

x-loyalty-token
Header string
required

Paxgateway Confidential Page:83/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Success MemberProfile

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.16. Retrieve Purchase Points

POST /lms/purchasePoints

Description

This service used for retrieve purchase points for member. If service returns success field as true,
the productNo field is kept with the conversation token for payment

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

request
Body request MilesPrice
required

Responses

Paxgateway Confidential Page:84/344

Paxgateway

HTTP
Description Schema
Code

PurchasePointsRes
200 Success
ponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.17. Retrieve Required Points

POST /lms/requiredPoints

Description

This service used for retrieve required points of booking given as request body field bookingId.
If amount’s sign type equals to REF then amount field in response body will be negative otherwise
field will be positive.
When used in reissue flow, client should send the current conversation token and set isReissue to
true.

Parameters

Type Name Description Schema

x-conversation-
Header token Required when isReissue is true. string
optional

Paxgateway Confidential Page:85/344

Paxgateway

Type Name Description Schema

x-loyalty-token
Header string
required

request RequiredPointsRequ
Body request
required est

Responses

HTTP
Description Schema
Code

RequiredPointsRes
200 Success
ponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.18. Retrieve Member Reservation List

GET /lms/reservationList

Description

This service used for retrieve member’s reservation list.

About "bookingStatus" fields that return in response to /lms/reservationList request:
TICKETED : The reservation was completed and ticketed.
RESERVED : The reservation is not yet ticketed.

Paxgateway Confidential Page:86/344

Paxgateway

CANCELLED : The reservation has been canceled.

ADDITIONAL_PAYMENT : Flight ticketing has been completed for this reservation. But there are
special services waiting to be ticketed.

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

endDate
Query Filter with end date FORMAT: dd.MM.yyyy string (date)
optional

filterType enum (TICKET,

Query Filter response with type. Default TICKET
optional FLIGHT)

startDate
Query Filter with start date FORMAT: dd.MM.yyyy string (date)
optional

Responses

HTTP
Description Schema
Code

< Reservation >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.10.19. Send member Pin via EMail

POST /lms/sendPinViaEmail

Paxgateway Confidential Page:87/344

Paxgateway

Description

This service used for retrieve member pin with member email.

Parameters

Type Name Description Schema

request SendPinViaEmailReq
Body request
required uest

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.10.20. Updates member profile

POST /lms/updateMemberProfile

Description

This service used for update member profile informations.

Paxgateway Confidential Page:88/344

Paxgateway

Parameters

Type Name Description Schema

x-loyalty-token
Header string
required

request UpdateMemberProfil
Body request
required eRequest

Responses

HTTP
Description Schema
Code

200 Success No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.11. Payment

Payment Services

2.11.1. Authorize payment

POST /payment/authorize

Description

Authorizes selected payment options, matches booking with payment if there is no redirection. If in

Paxgateway Confidential Page:89/344

Paxgateway

the "payment/options" response isAvs = true, required to send billing data information by payer.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request AuthorizePaymentRe
Body request
required quest

Responses

HTTP
Description Schema
Code

AuthorizePayment
200 Returns payment authorization result list
Response

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.11.2. Authorize After Redirect

POST /payment/authorizeAfterRedirect/{token}/{productNo}

Paxgateway Confidential Page:90/344

Paxgateway

Description

Completes authorization after Web or ACS redirection, matches booking with payment. This service
will be automatically called after the completion of redirection.

Parameters

Type Name Description Schema

productNo
Path productNo string
required

token
Path token string
required

request AuthorizePaymentAf
Body request
required terRedirectRequest

Responses

HTTP
Description Schema
Code

AuthorizePayment
200 Returns payment authorization result list
Response

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:91/344

Paxgateway

2.11.3. Credit card options

POST /payment/creditCardOptions

Description

Retrieves all available credit card payment options

Parameters

Type Name Description Schema

RetrieveCreditCardPa
request
Body request ymentOptionsReque
required
st

Responses

HTTP
Description Schema
Code

RetrieveCreditCard
200 Returns all available credit card payment option list PaymentOptionsRe
sponse

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:92/344

Paxgateway

2.11.4. Initialize Payment Process

POST /payment/initializePayment

Description

This service is used to start the payment step on the sapay side.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request InitializePaymentReq
Body request
required uest

Responses

HTTP
Description Schema
Code

InitializePaymentR
200 Return the initialize payment reference Id
esponse

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

Paxgateway Confidential Page:93/344

Paxgateway

• application/json

2.11.5. Loyalty redemption options

POST /payment/loyaltyRedemptionOptions

Description

Retrieves all available loyalty redemption payment options

Parameters

Type Name Description Schema

RetrieveLoyaltyRede
request
Body request mptionPaymentOpti
required
onsRequest

Responses

HTTP
Description Schema
Code

RetrieveLoyaltyRed
200 Returns all available loyalty redemption payment option list emptionPaymentO
ptionsResponse

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Paxgateway Confidential Page:94/344

Paxgateway

Produces

• application/json

2.11.6. Payment options

POST /payment/options

Description

Retrieves all available payment options

Parameters

Type Name Description Schema

request RetrievePaymentOpti
Body request
required onsRequest

Responses

HTTP
Description Schema
Code

RetrievePaymentO
200 Returns all available payment option list
ptionsResponse

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

Paxgateway Confidential Page:95/344

Paxgateway

• application/json

2.11.7. Retrieve Payment Results

POST /payment/retrievePaymentResult

Description

This service is used to check payment result and after start ticketing process.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request RetrievePaymentRes
Body request
required ultRequest

Responses

HTTP
Description Schema
Code

AuthorizePayment
200 Return the payment response
Response

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Paxgateway Confidential Page:96/344

Paxgateway

Produces

• application/json

2.12. Reservation

Reservation Services

2.12.1. Checks for available discounts

GET /booking/availableDiscounts

Description

This service used for check if available discounts for your booking. If there are available discount list
then It will return available discount list for your booking

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

bincodeInclude If true, response will contain bincode discounts.

Query boolean
optional Default "false"

Responses

HTTP
Description Schema
Code

<
200 Returns list of available discounts AvailableDiscount
> array

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:97/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Produces

• application/json

2.12.2. Retrieve Available Packages(Bundles) Service

GET /booking/availablePackages

Description

This service used for retrieve available packages for booking

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Success UpgradePackagesR
esponse > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Paxgateway Confidential Page:98/344

Paxgateway

Produces

• application/json

2.12.3. Check Phone Number is eligable for sending sms

POST /booking/canSendSMS

Description

This service used for check if phone number as given request body eligable for sending booking
informations.

Parameters

Type Name Description Schema

request
Body Can send sms request PhoneNumber
required

Responses

HTTP
Description Schema
Code

200 Returns true if phone number is eligable boolean

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:99/344

Paxgateway

Example HTTP response

Response 200

true

2.12.4. Cancels a booking or some of its segments. Segment calcellation is not

supported for non ticketed reservations

POST /booking/cancel

Description

This service used for cancel flights in booking. You have to set purpose enum in request model. If
purpose enum field setted CALCULATE then service just calculate pricing for cancelation. If purpose
enum field setted PERSIST then service will cancel given segments. If segment list is empty then
service cancels all flights in booking. After calculation if there is no penalty for cancelation
Priceoverview field will return with zero

Parameters

Type Name Schema

x-conversation-token
Header string
required

request
Body CancelBookingRequest
required

Responses

HTTP
Description Schema
Code

200 Returns difference amount Booking

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:100/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.5. Send HES code and check her/him available for the flight

POST /booking/checkHesCode

Description

Validate social security numbers of passengers with HES Code which is provided by passengers
during reservation.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

<
body CheckHesCodeByPas
Body New packages
required sengerRequest >
array

Responses

Paxgateway Confidential Page:101/344

Paxgateway

HTTP
Description Schema
Code

<
CheckHesCodeByP
200 Returns list of available discounts
assengerResponse
> array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.6. Modify Exists Contact(s) Service

POST /booking/contacts

Description

This service used for updating contact(s) informations in booking

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body
Body Sets contacts request < Contact > array
required

Paxgateway Confidential Page:102/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Success PriceResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.7. Retrieves Contact(s) Informations Service

GET /booking/contacts

Description

This service used for get contact(s) information in booking

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success < Contact > array

Paxgateway Confidential Page:103/344

Paxgateway

HTTP
Description Schema
Code

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.12.8. Booking Create Service

POST /booking/create

Description

This service used for creation booking for selected flights with selected fares

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

<
body
Body Fare referance ids BookingRequestItem
required
> array

Responses

HTTP
Description Schema
Code

200 Success Booking

405 Invalid Request No Content

Paxgateway Confidential Page:104/344

Paxgateway

Consumes

• application/json

Produces

• application/json

2.12.9. Set discount

POST /booking/discounts

Description

Set discount. Discount code should be "NONE" if no discount will applied.

Usage Tips:
- Discount informations are stored in the conversation token. If the token is updated then all of this
information will be lost while using POST /discount Service, so you should resend your request.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body
Body Set discount request Discount
required

Responses

HTTP
Description Schema
Code

200 Success PriceOverview

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:105/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.10. Remove discount

DELETE /booking/discounts

Description

This service removes all discounts and updates the conversation.

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success PriceOverview

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Paxgateway Confidential Page:106/344

Paxgateway

Consumes

• application/json

Produces

• application/json

2.12.11. Sets invoice

POST /booking/invoice

Description

Set Invoice. Invoice’s is should create with Company or Personal

Usage Tips:
- Personal Invoice option can only the Republic of Turkey 'EBILET' is used for bills.
- Company Invoice option can only be used during booking process except 'EBILET' invoice of
Republic of Turkey.
- Company Invoice and Personal Invoice informations are stored in the conversation token. If the
token is updated then all of this information will be lost while using POST Invoice Service, so you
should resend your request.
- POST Invoice service can also work as Modify service. If you post a new one, the conversation will
be updated with the new informations.
- POST invoice service has to be used after POST booking/passenger and POST booking/contacts
services to booking flow.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body
Body Invoice request model Invoice
required

Paxgateway Confidential Page:107/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Success Invoice

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.12. Delete invoice

DELETE /booking/invoice

Description

Delete Invoice

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success No Content

Paxgateway Confidential Page:108/344

Paxgateway

HTTP
Description Schema
Code

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.13. Retrieves booking with carousel options

POST /booking/manageBooking

Description

This service retrieves bookings of a passenger by using surname and booking id (PNR). <br> For
unticketed SSR’s price recalculate should be true

Parameters

Type Name Description Schema

request RetrieveBookingRequ
Body Retrieve booking request
required est

Responses

HTTP
Description Schema
Code

200 Success ManageBooking

401 Unauthorized No Content

Paxgateway Confidential Page:109/344

Paxgateway

HTTP
Description Schema
Code

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.14. Add New Package(Bundle)

POST /booking/newPackages

Description

This service used for set available packages to segments.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body NewPackagesReques
Body New packages
required t

Responses

HTTP
Description Schema
Code

200 Success Booking

Paxgateway Confidential Page:110/344

Paxgateway

HTTP
Description Schema
Code

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.15. Modify Passenger Informations Service

POST /booking/passengers

Description

This service is used for updating passengers informations, overwrites existing contacts

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

body
Body Fare referance ids PassengersRequest
required

Responses

Paxgateway Confidential Page:111/344

Paxgateway

HTTP
Description Schema
Code

200 Success PriceResponse

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.12.16. Retrieves passenger informations Service

GET /booking/passengers

Description

This service used for get passenger(s) informations in booking

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

< Passenger >

200 Success
array

401 Unauthorized No Content

403 Forbidden No Content

Paxgateway Confidential Page:112/344

Paxgateway

HTTP
Description Schema
Code

404 Not Found No Content

Produces

• application/json

2.12.17. Required to the trigger mail’s and text messages.

GET /booking/payLater

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Success Booking

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:113/344

Paxgateway

2.12.18. Retrieves available price freezing options for booking

GET /booking/priceFreezingOptions

Description

This service used for get available price freezing options for booking and its returns freezing prices
details

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

<
200 Returns list of available price freezing options PriceFreezingOptio
n > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.12.19. Purchases price freezing option

GET /booking/purchasePriceFreezing/{referenceId}

Paxgateway Confidential Page:114/344

Paxgateway

Description

This service used for get purchases price freezing option for given referenceId. If there is no price
freezing option for given refenceId its throws error. This service will return Booking model with
purchase option

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

referenceId Price Freezing Reference id from

Path string
required /priceFreezingOptions or /extraCharges

Responses

HTTP
Description Schema
Code

200 Success Booking

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.20. Modifies flights of a booking

POST /booking/reissue

Paxgateway Confidential Page:115/344

Paxgateway

Description

This service used for change flights in booking.

Usage Tips:
- If purpose enum field setted to CALCULATE, service just returns booking with new flights.
- If purpose enum field setted to PERSIST, service changes flights with new ones.

Parameters

Type Name Schema

x-conversation-token
Header string
required

request
Body ReissueRequest
required

Responses

HTTP
Description Schema
Code

200 Returns difference amount Booking

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.21. Retrieves booking

POST /booking/retrieve

Paxgateway Confidential Page:116/344

Paxgateway

Description

This service retrieves bookings of a passenger by using surname and booking id (PNR). <br> For
unticketed SSR’s price recalculate should be true

Parameters

Type Name Description Schema

request RetrieveBookingRequ
Body Retrieve booking request
required est

Responses

HTTP
Description Schema
Code

200 Success Booking

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.22. Retrieves booking from the conversation

GET /booking/retrieve

Description

Retrieves booking from the conversation

Paxgateway Confidential Page:117/344

Paxgateway

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

HTTP
Description Schema
Code

200 Returns difference amount Booking

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.12.23. HES code summary information passenger by passenger

GET /booking/retrieveHesCode

Description

HES code summary information service for the citizens of the Republic of Turkey.

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

Paxgateway Confidential Page:118/344

Paxgateway

HTTP
Description Schema
Code

<
CheckHesCodeByP
200 Returns list of available discounts
assengerResponse
> array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.12.24. HES code requirement check service

GET /booking/showHesCode

Description

This service used for retrieve if airline need to HES code. HES code requirement check service for
the citizens of the Republic of Turkey.

Parameters

Type Name Schema

x-conversation-token
Header string
required

Responses

Paxgateway Confidential Page:119/344

Paxgateway

HTTP
Description Schema
Code

200 Success HesCodeRequired

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.13. Ssr

SSR Services

2.13.1. Add or Modify booking SSR

POST /ssrs

Description

Add or Modify booking ssr. Modification decided by ssrType. if the "quantityPerPass" value of the
SSR that you want to add is equals or lower to 1, SSR is remove and than added again or if greater
than 1, SSR added again as a new block

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

Paxgateway Confidential Page:120/344

Paxgateway

Type Name Description Schema

body
Body SSR Modify request SsrModifyRequest
required

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.13.2. Available SSR list for reservation

GET /ssrs

Description

This service returns all available ssrs for given reservation.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

Paxgateway Confidential Page:121/344

Paxgateway

Type Name Description Schema

group
Query Filter response with free group code text string
optional

seatMap If true, response will contain seatMap

Query boolean
optional informations. Default "false"

sellType enum (FREE,

Query Filter response with sell type. Default ALL
optional NOT_FREE, ALL)

Responses

HTTP
Description Schema
Code

< AvailableSsrs >

200 Success
array

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.13.3. Delete booking SSR

DELETE /ssrs

Description

Deletes booking ssr.

Parameters

Paxgateway Confidential Page:122/344

Paxgateway

Type Name Description Schema

x-conversation-
Header token string
required

body
Body SSR Modify request SsrModifyRequest
required

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.13.4. Extra baggage rules

GET /ssrs/baggage/extraRules/{segmentId}

Description

This service used for get extra baggage rules.

Parameters

Paxgateway Confidential Page:123/344

Paxgateway

Type Name Description Schema

segmentId
Path Segment id. string
required

Responses

HTTP
Description Schema
Code

<
200 Success BaggageRuleRespo
nse > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.13.5. Fare information for baggages

GET /ssrs/baggage/fare/{segmentId}

Description

This service used for get Fare information for baggages.

Parameters

Paxgateway Confidential Page:124/344

Paxgateway

Type Name Description Schema

segmentId
Path Segment id. string
required

Responses

HTTP
Description Schema
Code

<
200 Success BaggageFareRespo
nse > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

2.13.6. Add or Modify booking SSR

POST /ssrs/batch

Description

Add or Modify booking ssr as batch

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

Paxgateway Confidential Page:125/344

Paxgateway

Type Name Description Schema

body < SsrModifyRequest

Body SSR Modify request
required > array

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.13.7. Delete SSR as Bath

DELETE /ssrs/batch

Description

Add or Modify booking ssr as batch

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

Paxgateway Confidential Page:126/344

Paxgateway

Type Name Description Schema

body < SsrModifyRequest

Body SSR Modify request
required > array

Responses

HTTP
Description Schema
Code

SsrModifyRespons
200 Success
e

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.13.8. SeatMap Service

GET /ssrs/seatMap/{segmentId}

Description

Returns seat map info for requested booking and segment.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

Paxgateway Confidential Page:127/344

Paxgateway

Type Name Description Schema

segmentId
Path Segment id. string
required

Responses

HTTP
Description Schema
Code

200 Success SeatMap

405 Invalid Request No Content

Consumes

• application/json

Produces

• application/json

2.14. Ticketing

Ticketing Services

2.14.1. Ticket Information for the print etc.

GET /ticket

Description

This service is used to ticket information for print etc.

Parameters

Type Name Schema

x-conversation-token
Header string
required

Paxgateway Confidential Page:128/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Returns payment authorization result list < Ticket > array

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found, No Content

Consumes

• application/json

Produces

• application/json

2.14.2. Ticket without payment

POST /ticket/ticketWithoutPayment

Description

This service is used to ticket reservations without payment. Use this service for zero or negative
price reservations.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

request TicketWithoutPayme
Body request
required ntRequest

Paxgateway Confidential Page:129/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Returns payment authorization result list No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

2.14.3. Ticket Information for the print etc. with ticket number.

GET /ticket/{ticketNumber}

Description

This service is used to ticket information for print etc.

Parameters

Type Name Description Schema

x-conversation-
Header token string
required

ticketNumber
Path Ticket Number string
required

Paxgateway Confidential Page:130/344

Paxgateway

Responses

HTTP
Description Schema
Code

200 Returns payment authorization result list < Ticket > array

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• application/json

Produces

• application/json

Paxgateway Confidential Page:131/344

Paxgateway

Chapter 3. Definitions

3.1. AbstractMemberProfile

Abstract member profile

Name Description Schema

addressList < MemberAddress >

List of addresses
optional array

birthDate Birth date

string (date)
optional Example : "11.01.1995"

consentAddres
Consent Address
s boolean
Example : true
optional

consentEmail Consent Email

boolean
optional Example : true

consentFax Consent Fax

boolean
optional Example : true

consentSms Consent Sms

boolean
optional Example : true

emails < MemberEmail >

List of e-mails
optional array

gender
Gender string
optional

givenName Firstname
string
optional Example : "JOHN"

knownTraveler
Number Known Traveler Number string
optional

Paxgateway Confidential Page:132/344

Paxgateway

Name Description Schema

language Language
string
optional Example : "TR"

maritalStatus
Marital status string
optional

marriageDate
Marriage date string (date)
optional

middleName Middlename
string
optional Example : "SMITH"

nationalId National ID
string
optional Example : "11111111111"

nationality Nationality
string
optional Example : "TR"

passportExpiry
Date Passport expire date string (date)
optional

passportNo
Passport no string
optional

personalInfoLis <
t MemberPersonalInfo
optional > array

<
phoneNumbers
List of phone numbers MemberPhoneNumb
optional
er > array

redressNumber
Redress Number string
optional

Paxgateway Confidential Page:133/344

Paxgateway

Name Description Schema

referringMemb
ershipID Referring member id string
optional

signupDate Member signup date

string
optional Example : "11.03.2019"

status Member status

string
optional Example : "AC"

surname Lastname
string
optional Example : "SNOW"

title Title
string
optional Example : "DR"

3.2. AbstractSsr

Special Request details base model

Name Description Schema

category
string
optional

code SSR code

string
optional Example : "SEAT"

explanation Explanation of Ssr

string
optional Example : "NTBL-NITELIKLI BILET"

free True when SSR is free of charge

boolean
optional Example : false

group SSR Group Code

string
optional Example : "CATERING"

Paxgateway Confidential Page:134/344

Paxgateway

Name Description Schema

isBundle True when SSR is part of selected bundle

boolean
optional Example : false

price
Price
optional

ssrType SSR type definition.

string
optional Example : ""

3.3. ActionDetail

Booking Action Details

Name Description Schema

available available information for selected action

boolean
optional Example : true

segments
< string > array
optional

3.4. AddInsuranceRequest

Insurance Add Request Model

Polymorphism : Composition

Name Description Schema

<
passengers
(Not required) Passengers IIN information list InsurancePassenger
optional
> array

policyCode
Example : "DOM-BASIC" string
optional

Paxgateway Confidential Page:135/344

Paxgateway

3.5. Address

Address

Name Description Schema

bldgRoom
string
optional

cityCode
City code string
optional

cityName
City name string
optional

countryCode
Country code string
optional

countryName
Country name string
optional

formatted
Is address formatted boolean
optional

lines
Address lines < string > array
optional

postalCode
Postal code string
optional

preferred Is preferred
boolean
optional Example : true

shareMarketIn
d boolean
optional

stateProvince
State province string
optional

Paxgateway Confidential Page:136/344

Paxgateway

Name Description Schema

streetNumber
Street number string
optional

useType
Use type string
optional

3.6. Age

Age Model

Name Description Schema

age
Example : 10 integer
optional

unit
Example : "MONTH" string
optional

3.7. AgeLimit

Age Limit Model

Name Description Schema

max
Age
optional

min
Age
optional

sector
Example : "DOMESTIC" string
optional

3.8. AgeLimitResponse

Age Limit Response Model

Paxgateway Confidential Page:137/344

Paxgateway

Name Description Schema

ageLimitForUn
attendedFlight Age Limit For Unattended Flight integer
optional

limits
List of grouped limits < AgeLimit > array
optional

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

3.9. AirReservationInfo

Name Schema

bagTagNumbers
< string > array
optional

bookingId
string
optional

flightInformation
FlightInfo
optional

pirReference
string
optional

3.10. AirTravelActivity

Segments of a flight

Name Description Schema

segments
List of segments < Segment > array
required

3.11. Aircraft

Aircraft information

Paxgateway Confidential Page:138/344

Paxgateway

Name Description Schema

model Aircraft model

string
required Example : "332"

name Aircraft brand

string
required Example : "Airbus"

type Aircraft type

string
required Example : "330"

3.12. AirlineData

Data to send the payment provider about flight

Name Description Schema

adultCount
Adult count integer (int32)
optional

childCount
Child count integer (int32)
optional

contactPerson
Contact person string
optional

countryOfResid
ence Country of residence string
optional

email
E-mail string
optional

fraudSalesType enum (Issue,

Fraud sales type
optional Reissue)

infantCount
Infant count integer (int32)
optional

Paxgateway Confidential Page:139/344

Paxgateway

Name Description Schema

minLegDepDat
e Example : "11.11.2018" string (date)
optional

paxList
List of airlinePax < AirlinePax > array
optional

phoneNumber
PhoneNumber
optional

pnrCreatedDat
e string (date-time)
optional

pnrExpireDate
string (date-time)
optional

pnrNo
PNR No string
required

segmentList < AirlineSegment >

List of airlineSegment
optional array

3.13. AirlinePax

Airline pax

Name Description Schema

paxGender enum (F, M, C, I, G,

Pax gender
optional U)

paxName
Pax name string
optional

paxSurname
Pax surname string
optional

Paxgateway Confidential Page:140/344

Paxgateway

3.14. AirlineSegment

Name Description Schema

arrLocationInfo
LocationInfo
required

depLocationInf
o LocationInfo
required

flightNo
Flight no string
required

schArrDate Scheduled arrival date

string (date)
required Example : "11.11.2018"

schDepDate Scheduled departure date

string (date)
required Example : "12.11.2018"

3.15. AllowedAction

Represents action options allowed in Booking

Polymorphism : Composition

Name Description Schema

ancillary show ancillary option to carousel

boolean
optional Example : true

bundleUpgrade show bundle upgrade option to carousel

boolean
optional Example : true

buy show buy option to carousel

boolean
optional Example : true

cancelCheckin show cancel checkin option to carousel

boolean
optional Example : true

Paxgateway Confidential Page:141/344

Paxgateway

Name Description Schema

cancelCheckinD
etails SegmentAction
optional

cancelFlight
CancelFlightAction
optional

cancelReservati
show cancel reservation to carousel
on boolean
Example : true
optional

changeContact show change contact option to carousel

boolean
optional Example : true

changeFlight
ChangeFlightAction
optional

checkin
ActionDetail
optional

manageBundle show manage bundle option to carousel

boolean
optional Example : true

printTicket
PrintTicket
optional

3.16. ApisField

Apis Model that contains fieldId and mandatory

Name Description Schema

fieldId
Field ID string
optional

mandatory Whether the field is required or not

boolean
optional Example : true

Paxgateway Confidential Page:142/344

Paxgateway

3.17. ApisRequest

Apis Request Model

Name Description Schema

nationality Nationality code

string
optional Example : "TR"

segmentId
Segment ID to query string
optional

3.18. ApisResponse

Apis Response Model

Name Description Schema

code National ID
string
optional Example : "11111111111"

fields
List of required fields < ApisField > array
optional

groupId Group ID for Apis

string
optional Example : "TRAPIS"

mandatory Whether the information is required or not

boolean
optional Example : true

3.19. Arranger

Reservation arranger

Name Description Schema

agencyCode
Agency Code string
optional

Paxgateway Confidential Page:143/344

Paxgateway

Name Description Schema

agencyName
Agency Name string
optional

agencyType
Agency Type string
optional

companyName
Company name string
optional

contact
Contact
optional

contactName
Contact name string
optional

currency
Currency type string
optional

iataNumber
Iata number string
optional

userCode
User code string
optional

userName
Username string
optional

3.20. AssociatedCoupon

AssociatedCoupon

Name Schema

associatedCouponNumber
string
optional

associatedTicketNumber
string
optional

Paxgateway Confidential Page:144/344

Paxgateway

Name Schema

couponNumber
string
optional

ticketNumber
string
optional

3.21. AsvcSsr

AsvcSsr

Name Description Schema

emdCouponNu
mber string
optional

emdTicketNum
ber string
optional

emdType
Emd Type enum (A, S)
optional

exchangable
boolean
optional

price
Price
optional

reasonForIssua
nceCode string
optional

reasonForIssua
nceExplanation string
optional

Paxgateway Confidential Page:145/344

Paxgateway

Name Description Schema

reasonForIssua
nceSubCode string
optional

reasonForIssua
nceSubExplana
string
tion
optional

refundable
boolean
optional

remark
string
optional

serviceQuantit
y integer
optional

3.22. AuthenticateUserRequest

User Credentials

Name Description Schema

password User password

string
required Example : "123456"

User Name ( can be user name, phone number or e-mail

username
adress) string
required
Example : "user1@example.com"

3.23. AuthorizationResult

Authorization result

Paxgateway Confidential Page:146/344

Paxgateway

Name Description Schema

amount
Amount number (double)
optional

ffPoint
Loyalty points number (double)
optional

message
Message string
optional

orderId
Order ID string
optional

paymentOptio
nId Payment option ID string
optional

price
PriceBase
optional

enum (ERROR,
APPROVED,
WEB_REDIRECT,
status THREE_D_SECURE_R
Status, returns APPROVED if successfull
optional EDIRECT, FAILED,
REVERSED,
NOT_ATTEMPTED,
INLINE)

3.24. AuthorizePaymentAfterRedirectRequest

Return value of authorizeAfterRedirect. Either psp or redirect response is returned based on the
payment method.

Paxgateway Confidential Page:147/344

Paxgateway

Name Schema

pspResponse
string
optional

redirectResponse
string
required

3.25. AuthorizePaymentRequest

Payment request

Name Description Schema

billingData
Payment request BillingData
optional

paymentReque
< PaymentRequest >
st Payment request
array
optional

productNo bookingId for reservation and price freezing, productNo for

string
required point purchase

"The method of returning the result for 3d secure payment

process": * HEADER - Result will be send as rest response
with X-Authorization-Status-${productNo} header. This
appropriate for native mobile applications. Listen webview
communication and wait for status header. If you recieve
returnType enum (HEADER,
status header you can close the webview. * MESSAGE -
optional MESSAGE, REDIRECT)
Result will be send inside a webpage from server then such
webpage will send the result via postMessage. This method
is appropriate for React-Native webview and iframe inside
webpage for client side handling. * REDIRECT - Result will be
post to returnUrl inside the parameter "result"

returnUrl If returnType is 'redirect' MW posts payment response to

string
optional returnUrl

Paxgateway Confidential Page:148/344

Paxgateway

3.26. AuthorizePaymentResponse

Returns 'APPROVED' or a payment redirect link except for BOH(Book on Hold) payments. If payment
type is BOH returns 'BOOK_ON_HOLD' and ticketTimeLimit,bookingId,pnrReferenceId etc.

Name Description Schema

bookingId
Pnr booking id string
optional

code
Payment code string
optional

message
Payment message string
optional

orderId
Payment order ID string
optional

pnrReferenceId
Pnr reference ID string
optional

pspData
Data to post for redirection string
optional

redirectUrl
Redirect url to follow to complete the payment string
optional

referenceId
Sapay reference ID string
optional

<
results
Result list for each payment method provided AuthorizationResult
optional
> array

Paxgateway Confidential Page:149/344

Paxgateway

Name Description Schema

enum (ERROR,
APPROVED,
WEB_REDIRECT,
THREE_D_SECURE_R
status
Payment status EDIRECT, FAILED,
optional
REVERSED,
NOT_ATTEMPTED,
INLINE,
BOOK_ON_HOLD)

ticketTimeLimit Ticket Time Limit

string (date-time)
optional Example : "24.09.2018 13:08:36"

3.27. AvailabilityRequest

Availability request

Name Description Schema

adultCount Adult passenger count

integer (int32)
optional Example : 1

enum (COCKPIT,
cabinClass
FIRST, ECONOMY,
optional
BUSINESS)

Child passenger count

childCount
Default : 0 integer (int32)
optional
Example : 1

currency Result currency. ISO Code for currencies

string
required Example : "TRY"

dateOffset Requested result date count.

integer
optional Example : 1

Paxgateway Confidential Page:150/344

Paxgateway

Name Description Schema

directFlightsOn
Get only direct flights
ly boolean
Example : true
optional

flightRequestLi
< FlightRequest >
st Requested port and dates
array
optional

Infant passenger count

infantCount
Default : 0 integer (int32)
optional
Example : 1

If true, uses passenger list from cache. Do not send

isReissue passenger count parameters while this is true.
boolean
optional Default : false
Example : false

promotionCod
Promotion code to apply discount
e string
Example : "SUKRUFARE"
optional

Soldier passenger count

soldierCount
Default : 0 integer (int32)
optional
Example : 1

Student passenger count

studentCount
Default : 0 integer (int32)
optional
Example : 1

Paxgateway Confidential Page:151/344

Paxgateway

Name Description Schema

enum (ONE_WAY,
ROUND_TRIP,
INBOUND_OPEN,
tripType
Trip Type MULTI_DIRECTIONAL
required
, OUTBOUND_OPEN,
INBOUND_OUTBOU
ND_OPEN)

3.28. AvailabilityResponseItem

Name Description Schema

dates < JourneysByDate >

Found flight by date
required array

journeyType enum (OUTBOUND,

Journey direction type
required INBOUND, BOUND)

route Route location code list

< string > array
optional Example : [ "ADA", "IST" ]

3.29. AvailableBaggage

Baggage information

Name Description Schema

price
Price
optional

sellType enum (EXCESS,

optional PACKAGE)

weight
Example : 15 integer
optional

Paxgateway Confidential Page:152/344

Paxgateway

3.30. AvailableDiscount

Available discount information

Name Description Schema

applicableCard
Bins List of new requests, object type is same as /booking/create < string > array
optional

discountCode
Discount code string
optional

isBincodeDisco
unt Is discount code available for isBincodeDiscount boolean
optional

price
Price
optional

promotionCod
eRequired Is promotion code required boolean
optional

3.31. AvailableSsr

Available SSR info

Name Description Schema

category
string
optional

code SSR code

string
optional Example : "SEAT"

explanation Explanation of Ssr

string
optional Example : "NTBL-NITELIKLI BILET"

Paxgateway Confidential Page:153/344

Paxgateway

Name Description Schema

free True when SSR is free of charge

boolean
optional Example : false

group SSR Group Code

string
optional Example : "CATERING"

isBundle True when SSR is part of selected bundle

boolean
optional Example : false

price
Price
optional

quantity Default quantity for per selection

string
optional Example : "10"

quantityPerPas
selectable quantity per passenger
s integer
Example : 1
optional

ssrType
Example : "" string
optional

3.32. AvailableSsrs

Available SSRs for a segment

Name Description Schema

availSsrs
Selectable additional ssrs < AvailableSsr > array
optional

bundleSsrs
Unselected ssrs from selected bundle < AvailableSsr > array
optional

packages
Available upgardeable packages < packages > array
optional

Paxgateway Confidential Page:154/344

Paxgateway

Name Description Schema

seatMap
SeatMap
optional

segmentId Segment Id
string
optional Example : "1234556"

packages

Name Description Schema

code package code

string
optional Example : "SADE"

price
Price
optional

3.33. BaggageAllowance

Standart Baggage Allowance

Name Description Schema

maxPieces Accepted max pieces

integer
required Example : 0

maxWeight Accepted max weight for baggage

integer
required Example : 15

measurementU
Measurament unit
nit string
Example : "KG"
required

passengerType enum (ADLT, CHLD,

Passenger type
required INFT)

type Accepted Type

string
required Example : "WEIGHT"

Paxgateway Confidential Page:155/344

Paxgateway

3.34. BaggageFareResponse

Baggage information

Name Description Schema

availableBagga
< AvailableBaggage >
ges Price Details
array
optional

passengerId
Example : "12345678" string
optional

3.35. BaggageRuleResponse

Baggage rule response

Name Description Schema

allowedNumOf
Pieces Example : 4 integer
optional

baggageAllowa
enum (PIECE,
nceType
WEIGHT)
optional

firstOversize
Dimension
optional

freeBaggageAll
owance Example : 15 integer
optional

maxAllowedW
eight Example : 30 integer
optional

Paxgateway Confidential Page:156/344

Paxgateway

Name Description Schema

minAllowedWe
ight Example : 10 integer
optional

secondOversize
Dimension
optional

servedWeight
MeasureUnit
optional

3.36. BankInformation

BankInformation

Name Schema

code
string
optional

extraRPH
string
optional

name
string
optional

3.37. BaseFarePrice

Price details by passenger type

Name Description Schema

baseFare
Price
required

discountTotal
Price
optional

Paxgateway Confidential Page:157/344

Paxgateway

Name Description Schema

discounts
Discounts list < CodedPrice > array
optional

feeTotal
Price
optional

fees
Fees list < CodedPrice > array
optional

nonRefundable
Items Non refundable item list for reissue cases < CodedPrice > array
optional

penalties
Penalties list < CodedPrice > array
optional

penaltyTotal
Price
optional

remarks
Additional informations < string > array
optional

surchargeTotal
Price
optional

surcharges
Surcharges list < CodedPrice > array
optional

taxTotal
Price
optional

taxes
Taxes list < CodedPrice > array
optional

totalAmount
Price
required

Paxgateway Confidential Page:158/344

Paxgateway

3.38. BaseFlightBasedActionDetail

BaseFlightBasedActionDetail

Name Description Schema

available
boolean
optional

flights
Flight List < FlightAction > array
optional

segmentBased
boolean
optional

3.39. BasePaymentDetail

Base Payment Detail Model For Ticketing Services

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

Paxgateway Confidential Page:159/344

Paxgateway

Name Description Schema

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.40. BillingData

Billing Data Information For Payment.If in the payment/options response isAvs = true required to
send this information from credit cart owner.

Paxgateway Confidential Page:160/344

Paxgateway

Name Description Schema

city city name

string
optional Example : "Lindenhurst"

country country name

string
optional Example : "USA"

postalCode postal code

string
optional Example : "11757"

street street name

string
optional Example : "88 Honeysuckle Lane"

street2 second street name

string
optional Example : "1802 Clark Street"

3.41. BkmExpressDetail

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

Paxgateway Confidential Page:161/344

Paxgateway

Name Description Schema

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.42. BkmPayment

BKM payment

Paxgateway Confidential Page:162/344

Paxgateway

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

campaignCode
Campaign code string
optional

number
Number string
optional

paymentOptio
nId Unique id of payment option string
required

3.43. BoardingCard

Boarding Card

Name Description Schema

baggageCount
Baggage count string
optional

baggageWeight
Baggage weight string
optional

barcodeData
Barcode data string
optional

boardingGate
Boarding gate string
optional

boardingTime
Boarding time string
optional

bookingId
PNR number string
optional

Paxgateway Confidential Page:163/344

Paxgateway

Name Description Schema

cabinClass
Cabin class string
optional

cabinGroup
Cabin group string
optional

checkDigit
Check digit string
optional

checkinSeq
Checkin sequence string
optional

couponNumber
Coupon number string
optional

flightInformati
on FlightInformation
optional

frequentFlyerIn
fo Frequent flyer info string
optional

isIatci
true for the boarding cards from iatci check-ins boolean
optional

isSsss
Secondary Security Screening Selection boolean
optional

isTsaPreCheck
true for TSA Precheck passengers boolean
optional

monitorWarnin
g Monitor warning string
optional

Paxgateway Confidential Page:164/344

Paxgateway

Name Description Schema

passengerBirth
Passenger birthdate
Date string (date)
Example : "11.11.1980"
optional

passengerGend
er Passenger gender string
optional

passengerId
Passenger Id integer (int64)
optional

passengerNam
e Passenger name string
optional

printCount
Print count string
optional

rezClass
Reservation class string
optional

seatName
Seat name string
optional

ssrInfo < BoardingCardSSR >

List of ssrs
optional array

ticketNumber
Ticket number string
optional

transitInfo
Transit information string
optional

3.44. BoardingCardLocation

Arrival and Depature Location Boarding Infos

Paxgateway Confidential Page:165/344

Paxgateway

Name Description Schema

cityName
City name string
optional

portCode
Port code string
optional

terminal
Terminal string
optional

3.45. BoardingCardRequest

Boarding card request

Name Description Schema

If true, response will contain boarding cards for iatci check-

includeIatci ins.
boolean
optional Default : false
Example : true

<
passengerList
List of passengers PassengerDcsInform
optional
ation > array

segmentId
Segment ID string
optional

3.46. BoardingCardSSR

Boarding Card SSR

Name Description Schema

approveDate
Example : "01.01.2018 13:35" string (date-time)
optional

Paxgateway Confidential Page:166/344

Paxgateway

Name Description Schema

code
string
optional

crsSsrExplanati
city code
on string
Example : "3A"
optional

entryDate
Example : "01.01.2018 13:35" string (date-time)
optional

explanation
string
optional

optionExpireTi
me Example : "01.01.2018 13:35" string (date-time)
optional

paymentStatus
string
optional

ssrStatus
string
optional

ssrSubCode
string
optional

ticketNumber
Example : 12345.0 number (long)
optional

3.47. BookOnHoldDetail

Book on hold(BOH) payment details model for GET /ticket service

Polymorphism : Composition

Paxgateway Confidential Page:167/344

Paxgateway

Name Description Schema

avsEnabled
Example : true boolean
optional

bankName
string
optional

branchName
string
optional

capturePayme
ntToolNumber Example : true boolean
optional

channelName
string
optional

customerBank
string
optional

customerName
string
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

location
string
optional

pares
string
optional

Paxgateway Confidential Page:168/344

Paxgateway

Name Description Schema

paymentAmou
nt number (double)
optional

paymentCode
string
optional

paymentCurren
cy string
optional

paymentDate Payment date and time

string (date-time)
optional Example : "01.01.2018 13:35"

paymentMetho
d string
optional

paymentRefere
nce string
optional

paymentRefere
nceID string
optional

paymentStatus
string
optional

paymentSubTy
peCode string
optional

paymentSyste
m string
optional

Paxgateway Confidential Page:169/344

Paxgateway

Name Description Schema

paymentSyste enum (ISW, FWY,

m1 BOH, PYU, VCM, TGS,
optional BEE, SDD)

paymentToolN
o string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

receiptNo
string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

tranxRef
string
optional

Paxgateway Confidential Page:170/344

Paxgateway

3.48. BookOnHoldPayment

Book on hold payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

paymentOptio
nId Unique id of payment option string
required

3.49. Booking

Name Description Schema

arrangerInfo
Arranger
optional

bookingCreate
Booking created date
Date string (date-time)
Example : "01.01.2018 13:35"
optional

bookingId Unique Booking Id ( PNR )

string
optional Example : "ABC123"

contacts
Contact informations for booking < Contact > array
optional

flights
Booking flights < Flight > array
optional

hesRequired check HES code requirement

boolean
optional Example : false

insurance
Insurance
optional

Paxgateway Confidential Page:171/344

Paxgateway

Name Description Schema

needPayment Booking need payment

boolean
optional Example : false

package
Package
optional

passengers
Passenger informations for booking < Passenger > array
optional

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

priceDetails
Price Details < PriceDetail > array
optional

priceOverview
PriceOverview
optional

refundPayment <
AmountList refund amount list of the booking RefundPaymentAmo
optional unt > array

refundPriceOve
RefundPriceOvervie
rview
w
optional

specialRequest
s SpecialRequests
optional

<
ticketList
Passenger List Based On TicketList PassengerListBasedO
optional
nTicket > array

ticketTimeLimit Ticket expire time

string (date)
optional Example : "01.01.2018 13:35"

Paxgateway Confidential Page:172/344

Paxgateway

Name Description Schema

enum (ONE_WAY,
MULTI_DIRECTIONAL
, INBOUND_OPEN,
tripType
Trip Type ROUND_TRIP,
optional
OUTBOUND_OPEN,
INBOUND_OUTBOU
ND_OPEN)

3.50. BookingRequestItem

Booking item type

Name Description Schema

Fare reference id
fareReferenceI
Example :
d string
"e9b115509e52995884570f285d0053a8314444f
optional
"

packageId Fare package unique id

string
optional Example : "PRE_DOM_FLX$$PRE_DOM_FLX"

3.51. CancelBookingRequest

Cancel booking request

Name Description Schema

purpose
OperationPurpose
optional

segments Segment ids to be removed. If this value is undefined or null

< string > array
optional whole booking will be cancelled.

Paxgateway Confidential Page:173/344

Paxgateway

3.52. CancelCheckInRequest

Checkin Cancel Model

Name Schema

passengers
< PassengerSimpleInformation > array
optional

segmentId
string
optional

3.53. CancelCheckInResponse

Checkin Cancel Response Model

Name Description Schema

checkedIn
Passenger is a look checked or not boolean
optional

passenger PassengerSimpleInfo
optional rmation

3.54. CancelFlightAction

CancelFlightAction

Polymorphism : Composition

Name Description Schema

available
boolean
optional

flights
Flight List < FlightAction > array
optional

segmentBased
boolean
optional

Paxgateway Confidential Page:174/344

Paxgateway

3.55. CashDetail

Cash Detail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

cash
Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

Paxgateway Confidential Page:175/344

Paxgateway

Name Description Schema

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.56. CashPayment

Cash payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

paymentOptio
nId Unique id of payment option string
required

Paxgateway Confidential Page:176/344

Paxgateway

3.57. Category

Name Schema

id
integer (int64)
optional

name
string
optional

sectionId
integer (int64)
optional

3.58. CclDefinitions

Name Schema

categories
< Category > array
optional

communicationPreferences
< CommunicationPreference > array
optional

sections
< Section > array
optional

subjects
< Subject > array
optional

3.59. ChangeFlightAction

ChangeFlightAction

Polymorphism : Composition

Name Description Schema

available
boolean
optional

Paxgateway Confidential Page:177/344

Paxgateway

Name Description Schema

flights
Flight List < FlightAction > array
optional

manageBookin
gActions ChangeableData
optional

segmentBased
boolean
optional

3.60. ChangeMemberPinRequest

Change Member Pin

Name Description Schema

currentPin
Current pin string
optional

newPin
New pin string
required

3.61. ChangeableData

Changeable data model used to booking

Name Schema

arrPort
boolean
optional

cabinClassDowngrade
boolean
optional

cabinClassUpgrade
boolean
optional

Paxgateway Confidential Page:178/344

Paxgateway

Name Schema

depDate
boolean
optional

depPort
boolean
optional

tripType
boolean
optional

3.62. ChargedSms

ChargedSms

Name Schema

price
Price
optional

selected
boolean
optional

3.63. CheapestFlightsFare

Name Description Schema

arrDate Arrival Flight date(just for vayant flights)

string (date)
optional Example : "01.03.2019"

best Represents the lowest price in the list

boolean
required Example : true

depDate Departure Flight date

string (date)
required Example : "01.03.2019"

noflight Represents if the noflight or not

boolean
required Example : false

Paxgateway Confidential Page:179/344

Paxgateway

Name Description Schema

outdated Represents if the flight is outdated or not

boolean
required Example : false

price
Price
required

3.64. CheapestFlightsRequest

CheapestFlights request

Name Description Schema

adultCount Adult passenger count

integer (int32)
optional Example : 1

enum (COCKPIT,
FIRST,
PREMIUM_BUSINESS
cabinClass Cabin class
, BUSINESS,
optional Example : "ECONOMY"
EXECUTIVE_ECONO
MY, PNL, ECONOMY,
PROMO, REGULAR)

currency Result currency. ISO Code for currencies

string
required Example : "TRY"

flightRequestLi
< FlightRequest >
st Requested port and dates
array
optional

Paxgateway Confidential Page:180/344

Paxgateway

Name Description Schema

enum (ONE_WAY,
ROUND_TRIP,
INBOUND_OPEN,
tripType
Trip Type MULTI_DIRECTIONAL
required
, OUTBOUND_OPEN,
INBOUND_OUTBOU
ND_OPEN)

3.65. CheapestFlightsResponse

Name Description Schema

JourneyType enum (OUTBOUND,

Journey direction type
required INBOUND, BOUND)

arrStartDate Arrival start date of listed flights(just for vayant flights).

string (date)
optional Example : "01.03.2019"

dateOffsetLimit Represents the number of days in the query interval

integer
optional Example : 1

depStartDate Departure start date of listed flights.

string (date)
optional Example : "01.03.2019"

<
fares
Daily low price info CheapestFlightsFare
required
> array

isCalendarView Represents that query is month based

boolean
optional Example : false

route
Available route list < string > array
optional

3.66. CheckHesCodeByPassengerRequest

check HES code request model

Paxgateway Confidential Page:181/344

Paxgateway

Name Description Schema

hesCode
HES code string
optional

hesDestination
Address HES code destination address string
optional

passengerId
Passenger ID string
optional

3.67. CheckHesCodeByPassengerResponse

check HES code response model

Name Description Schema

currentHealthS
tatus Passenger Health Status string
optional

destinationAdd
ress HES code destination address. string
optional

errorCode
Error code in case of possible error. string
optional

errorMessage
Error message in case of possible error. string
optional

expirationDate HES code expiration date

string (date-time)
optional Example : "01.01.2018 13:35"

hesCode
HES code string
optional

Paxgateway Confidential Page:182/344

Paxgateway

Name Description Schema

maskedIdentity
Number Masked Identity Number string
optional

name
Passenger Name string
optional

passengerId
Passenger ID string
optional

socialSecurityN
o Passenger Social Security Number string
optional

suitableForTick
eting Result for the continue or break ticketing. boolean
optional

surname
Passenger Surname string
optional

3.68. CheckInInformation

Check-in information

Name Description Schema

addressList
List of adresses < Address > array
optional

baggageInfoList
List of baggages < DcsBaggage > array
optional

barcodeUrl
Barcode URL string
optional

Paxgateway Confidential Page:183/344

Paxgateway

Name Description Schema

boardingCardPr
intable Printable boarding card string
optional

checkedIn
Is passenger checked in boolean
optional

couponNumber
Coupon number string
optional

couponStatus
Coupon status string
optional

dcsSequenceN
umber Dc sequence number string
optional

deniedBoardVo
lunteer Denied board volunteer boolean
optional

documentList
List of documents < Document > array
optional

elligibleForChe
ckin Is passenger elligible for checkin boolean
optional

originalCabinCl
assCode Original cabin class code string
optional

parentSequenc
Parent sequence for infant, required only if an infant is
e integer
present
optional

Paxgateway Confidential Page:184/344

Paxgateway

Name Description Schema

passenger PassengerDcsInform
optional ation

remark
string
optional

resBookDesigC
ode string
optional

seatInfoList
List of seats < Seat > array
optional

ssrList
List of special service requests < SSR > array
optional

ticketNumber
Ticket number string
optional

upgradeCabinC
lassCode Upgrade cabin class code string
optional

3.69. CheckInRequest

Check-in request

Name Description Schema

passengerInfoL <
ist List of passenger informations PassengerInformatio
optional n > array

segmentId
Segment id string
optional

Paxgateway Confidential Page:185/344

Paxgateway

3.70. CheckInResponse

Check-in response

Name Description Schema

checkinInforma <
tionList List of checkin informations CheckInInformation
optional > array

iatciCheckinInf <
ormationList List of iatci checkin informations IatciCheckInInformati
optional on > array

3.71. CheckTwoFactorAuthRequest

Check two factor authentication request

Name Description Schema

action Current action

string
optional Example : "ManageBooking"

code Two factor authentication code

string
optional Example : "3TVR"

id id of current operation
string
optional Example : "VGKJ0Y"

3.72. ChequePayment

Cheque payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

Paxgateway Confidential Page:186/344

Paxgateway

Name Description Schema

bankInfo
Bank info string
optional

chequeNumber
Cheque number string
optional

paymentOptio
nId Unique id of payment option string
required

3.73. ChequePaymentDetail

Cheque Payment Detail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

bankInformatio
n string
optional

capturePayme
ntToolNumber Example : true boolean
optional

chequeNumber
string
optional

description
string
optional

Paxgateway Confidential Page:187/344

Paxgateway

Name Description Schema

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

Paxgateway Confidential Page:188/344

Paxgateway

Name Description Schema

transactionFee
Applies Example : true boolean
optional

3.74. ChupopPayment

Chupop payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

paymentOptio
nId Unique id of payment option string
required

3.75. City

City

Name Description Schema

code city code

string
optional Example : "IST"

name city full name

string
optional Example : "Istanbul"

3.76. CityList

City list information model

Paxgateway Confidential Page:189/344

Paxgateway

Name Description Schema

city
city information list < CityPort > array
optional

3.77. CityPort

Port list model

Polymorphism : Composition

Name Description Schema

codeContext
code context string
optional

locationCode
location code string
optional

locationName
location name string
optional

locationNameL
anguage language of location name string
optional

portList
PortList
optional

3.78. ClaimRewardMilesRequest

Claim Reward Miles

Name Description Schema

bookingId
PNR number string
optional

departureDate Departure date

string (date)
required Example : "24.09.2018"

Paxgateway Confidential Page:190/344

Paxgateway

Name Description Schema

route
FlightLocation
optional

ticketNumber
Ticket number string
optional

3.79. CodeValuePair

Code value pair

Name Description Schema

code
Code string
optional

value
value string
optional

3.80. CodedPrice

Price information

Polymorphism : Composition

Name Description Schema

code Price for code. Like tax code

string
optional Example : "1003"

currency Currency ISO code

string
required Example : "TRY"

name Name of coded price

string
optional Example : "STANDART_DOMESTIC"

redeemedMiles
Equivalent miles number
optional

Paxgateway Confidential Page:191/344

Paxgateway

Name Description Schema

Amount
value
Minimum value : 0 number (money)
required
Example : 125.02

3.81. CommunicationPreference

Name Schema

id
string
optional

name
string
optional

3.82. Company

Company

Polymorphism : Composition

Name Description Schema

cityCode
City code string
optional

code
Code string
optional

codeContext
Code context string
optional

companyFullNa
me Company full name string
optional

Paxgateway Confidential Page:192/344

Paxgateway

Name Description Schema

companyLegal
Name Company legal name string
optional

companyShort
Name Company short name string
optional

contactName
Contact name string
optional

countryCode
Country code string
optional

iataCode
IATA code string
optional

localAuthorityC
ode Local authority code string
optional

taxNumber
Tax number string
optional

taxOffice
Tax office string
optional

3.83. CompanyInvoice

Company Invoice Type

Name Description Schema

address
Address string
optional

companyName
Company full name string
optional

Paxgateway Confidential Page:193/344

Paxgateway

Name Description Schema

taxNumber
Tax number string
optional

taxOffice
Tax Office string
optional

3.84. ConjunctiveTicket

Conjunctive Ticket Model For Ticketing Service

Name Description Schema

ticketNumber Ticket Number

string
optional Example : "3842400699975"

3.85. Contact

Contact informations

Name Description Schema

address
Address
optional

alternativeEma
Contact alternative email address
il string
Example : "asd@asd.com"
optional

alternativePho
neNumber PhoneNumber
optional

company
SimpleCompany
optional

country Country
string
optional Example : "TR"

Paxgateway Confidential Page:194/344

Paxgateway

Name Description Schema

email Contact email address

string
optional Example : "asd@asd.com"

givenName Contact first name

string
optional Example : "John"

middleName Contact middle name

string
optional Example : "Smith"

phoneNumber
PhoneNumber
optional

shareMarketIn
shareMarketInd
d boolean
Example : false
optional

smsRezInfo smsRezInfo
boolean
optional Example : false

surname Contact surname

string
optional Example : "Doe"

3.86. CountryInfo

PortsOfCountry service response country information model

Polymorphism : Composition

Name Description Schema

codeContext
code context string
optional

domesticCurre
ncy domestic currency code string
optional

Paxgateway Confidential Page:195/344

Paxgateway

Name Description Schema

icaoCode
icao code string
optional

internationalCu
rrency international currency code string
optional

locationCode
location code string
optional

locationName
location name string
optional

locationNameL
anguage language of location name string
optional

region
region information string
optional

stateList
state list StateList
optional

weeklyHolidays
weekly holidays string
optional

3.87. Coupon

Coupon Model For Ticketing Services

Name Description Schema

asvcSsr
AsvcSsr
optional

bookingId Booking Number

string
optional Example : "ZW49AV"

Paxgateway Confidential Page:196/344

Paxgateway

Name Description Schema

consumedAtIss
uence Example : true boolean
optional

couponNumber Coupon Number

string
optional Example : "3842400699975"

couponSegmen
t CouponSegment
optional

couponStatus Coupon Status

string
optional Example : "EXAMPLE"

noShow
Example : true boolean
optional

noStopOverInd
Stop Over Indicator info
icator string
Example : "EXAMPLE"
optional

notValidAfter Not valid after info

string
optional Example : "18.03.2019"

notValidBefore Not valid before info

string
optional Example : "18.03.2019"

passenger
Passenger
optional

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

presentAt
Example : "EXAMPLE" string
optional

presentTo
Example : "EXAMPLE" string
optional

Paxgateway Confidential Page:197/344

Paxgateway

Name Description Schema

sac
Example : "EXAMPLE" string
optional

seatName Seat name explanation string

string
optional Example : "16B"

ssr
SSR
optional

ticketDocumen
Ticket Document Number
tNbr string
Example : "123412341324"
optional

3.88. CouponSegment

Coupon Segment for ticketing services

Name Schema

actionCode
string
optional

addOnSegment
boolean
optional

fareInfo
ThreeDomainSecurity
optional

flightSegment
Segment
optional

marriageGrp
string
optional

mealList
< string > array
optional

Paxgateway Confidential Page:198/344

Paxgateway

Name Schema

referenceID
string
optional

responseCode
string
optional

sequenceNumber
integer
optional

status
string
optional

waitListPriorityCode
string
optional

3.89. CreditCardDetail

Credit Card Detail Model For Ticketing Services

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

billToAddress
string
optional

billToAddress2
string
optional

billToCountry
string
optional

billToPostalCod
e string
optional

Paxgateway Confidential Page:199/344

Paxgateway

Name Description Schema

billToState
string
optional

capturePayme
ntToolNumber Example : true boolean
optional

cardHolderNa
me string
optional

cardNumber
string
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

Paxgateway Confidential Page:200/344

Paxgateway

Name Description Schema

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

validUntil
string
optional

validationCode
string
optional

3.90. CreditCartPayment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

Paxgateway Confidential Page:201/344

Paxgateway

Name Description Schema

cvv
CVV string
optional

encryptionData Encripted credit card info. This field is used for worldpay
string
optional payment

expireDateMo
nth Expire date - month string
optional

expireDateYear
Expire date - year string
optional

holder
Card holder string
optional

number
Card number string
optional

paymentOptio
nId Unique id of payment option string
required

3.91. Currencies

Supported and default currency types

Name Description Schema

defaultCurrenc
y Currency
required

values
Supported currency types < Currency > array
required

Paxgateway Confidential Page:202/344

Paxgateway

3.92. Currency

Basic currency model

Name Description Schema

code
Example : "TRY" string
optional

doubleDigits
Example : "2" string
optional

3.93. DcsBaggage

Baggage

Name Description Schema

excessPieceCou
nt Excess piece count integer
optional

excessWeight
Excess weight number
optional

freeBaggagePie
ces Free baggage pieces integer
optional

freeBaggageW
eight Free baggage weight number
optional

totalWeight
Total weight number
optional

3.94. DeleteInsuranceRequest

Insurance Delete Request Model

Paxgateway Confidential Page:203/344

Paxgateway

Polymorphism : Composition

Name Description Schema

policyCode
Example : "DOM-BASIC" string
optional

3.95. Dimension

Dimension type

Name Schema

depth
number
optional

height
number
optional

width
number
optional

3.96. DirectDebitDetail

DirectDebitDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

accountHolder
string
optional

avsEnabled
Example : true boolean
optional

bankCode
string
optional

Paxgateway Confidential Page:204/344

Paxgateway

Name Description Schema

bic
string
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

iban
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

Paxgateway Confidential Page:205/344

Paxgateway

Name Description Schema

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.97. Discount

Discount type

Name Description Schema

binCode
Bin code string
optional

discountCode
Discount code string
required

promotionCod
e Promotion code string
optional

Paxgateway Confidential Page:206/344

Paxgateway

3.98. Document

Passenger id document information

Name Description Schema

birthCountry Country of birth

string
optional Example : "TUR"

birthDate Passenger birhtDate

string (date)
optional Example : "28.12.1980"

birthPlace
Place of birth string
optional

contactName
Cantact name string
optional

docEffectiveDa
Document effective date
te string (date)
Example : "28.12.2020"
optional

docExpireDate Document expire date

string (date)
optional Example : "28.12.2020"

docHolderNam
e Document holder name string
optional

docHolderNati
Document holder nationality
onality string
Example : "DEU"
optional

docId Document serial no, or id etc.

string
optional Example : "11111111111"

docIssueAuthor
Document issue authority
ity string
Example : "Authority"
optional

Paxgateway Confidential Page:207/344

Paxgateway

Name Description Schema

docIssueCountr
Country iso code
y string
Example : "TUR"
optional

docIssueLocati
Document issue location
on string
Example : "FRA"
optional

docIssueStateP
Document issue state
rov string
Example : "NY"
optional

docType Document type, like ID Card, SSN, Passport etc

string
optional Example : "PASSPORT"

gender
Passenger gender enum (M, F, C, I)
optional

givenName
Passenger given name string
optional

nameTitle
Passenger name title string
optional

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

postalCode
Postal Code string
optional

redressNumber
Redress Number string
optional

remark
Remark string
optional

surname
Passenger surname string
optional

Paxgateway Confidential Page:208/344

Paxgateway

3.99. DummyPosPayment

Dummy pos payment, used for testing purposes, does not use 3D secure payment method

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

approvalNumb
er Approval number string
optional

extraInfo
Extra info string
optional

paymentOptio
nId Unique id of payment option string
required

toolType
Tool type string
optional

3.100. ElectronicDocumentDeliveryPayment

Electronic document delivery payment

Polymorphism : Composition

Name Description Schema

accountOwner
Account owner string
optional

amount
Payment amount number (double)
required

Paxgateway Confidential Page:209/344

Paxgateway

Name Description Schema

bic
Bank identifier code string
optional

iban
IBAN string
optional

paymentOptio
nId Unique id of payment option string
required

3.101. Email

Person Email Type

Name Description Schema

email E-mail
string
optional Example : "aaa@bbb.com"

preferred preferred (true)

boolean
optional Example : true

useType Use type

string
optional Example : "PERSONAL"

3.102. EmdPaymentDetail

EmdPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

Paxgateway Confidential Page:210/344

Paxgateway

Name Description Schema

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

emdHolder
Passenger
optional

endNumber
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

Paxgateway Confidential Page:211/344

Paxgateway

Name Description Schema

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

totalEmdAmou
nt Price
optional

transactionFee
Applies Example : true boolean
optional

3.103. EnrollMemberRequest

Enroll member request type

Polymorphism : Composition

Name Description Schema

addressList < MemberAddress >

List of addresses
optional array

birthDate Birth date

string (date)
optional Example : "11.01.1995"

Paxgateway Confidential Page:212/344

Paxgateway

Name Description Schema

consentAddres
Consent Address
s boolean
Example : true
optional

consentEmail Consent Email

boolean
optional Example : true

consentFax Consent Fax

boolean
optional Example : true

consentSms Consent Sms

boolean
optional Example : true

emails < MemberEmail >

List of e-mails
optional array

enrollmentSou
Enrollment source
rce string
Example : "WEB"
optional

gender
Gender string
optional

givenName Firstname
string
optional Example : "JOHN"

knownTraveler
Number Known Traveler Number string
optional

language Language
string
optional Example : "TR"

maritalStatus
Marital status string
optional

marriageDate
Marriage date string (date)
optional

Paxgateway Confidential Page:213/344

Paxgateway

Name Description Schema

middleName Middlename
string
optional Example : "SMITH"

nationalId National ID
string
optional Example : "11111111111"

nationality Nationality
string
optional Example : "TR"

passportExpiry
Date Passport expire date string (date)
optional

passportNo
Passport no string
optional

personalInfoLis <
t MemberPersonalInfo
optional > array

<
phoneNumbers
List of phone numbers MemberPhoneNumb
optional
er > array

pin
Member login password string
optional

redressNumber
Redress Number string
optional

referringMemb
ershipID Referring member id string
optional

signupDate Member signup date

string
optional Example : "11.03.2019"

Paxgateway Confidential Page:214/344

Paxgateway

Name Description Schema

status Member status

string
optional Example : "AC"

surname Lastname
string
optional Example : "SNOW"

title Title
string
optional Example : "DR"

3.104. EnrollMemberResponse

Enroll Member Response Type

Name Description Schema

memberId Member ID
string
optional Example : "905415576"

signupDate Sign-up date

string (date-time)
optional Example : "24.09.2018 13:08:36"

3.105. ErrorResponse

Error Response Type

Name Description Schema

error Error Code

string
required Example : "ERR0001"

message Error definition

string
optional Example : "Not Found!"

3.106. ExpectedEarnedMilesResponse

Expected earned miles response type

Paxgateway Confidential Page:215/344

Paxgateway

Name Description Schema

miles
Miles number
optional

3.107. ExternallyHandledPaymentDetail

EmdPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

bankInformatio
< BankInformation >
nList
array
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

externallyHand
<
ledPaymentTo
ExternallyHandledPa
olList
ymentTool > array
optional

extraInformati
on string
optional

Paxgateway Confidential Page:216/344

Paxgateway

Name Description Schema

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

invoiceNumber
string
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

Paxgateway Confidential Page:217/344

Paxgateway

Name Description Schema

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

transactionID
string
optional

3.108. ExternallyHandledPaymentTool

ExternallyHandledPaymentTool

Name Schema

code
string
optional

description
string
optional

extraRPH
string
optional

3.109. ExtraCharges

Name Description Schema

chargedSms
ChargedSms
optional

otherFees
Other fees < CodedPrice > array
optional

Paxgateway Confidential Page:218/344

Paxgateway

Name Description Schema

priceFreezingO <
ptions Price freezing options PriceFreezingOption
optional > array

serviceFee
CodedPrice
optional

taxes
Service Fee taxes < CodedPrice > array
optional

totalAmount
Price
optional

totalTax
Price
optional

3.110. Fare

Price information

Name Description Schema

cabinClassOrde
r integer
optional

displayContain
er string
optional

displayOrder
integer
optional

lowestPrice
Price
required

packages
Additional packages < Package > array
required

Paxgateway Confidential Page:219/344

Paxgateway

Name Description Schema

priceDetails
Price details < FarePrice > array
required

priceOverview
PriceOverview
required

referenceId Uniuque fare referance id for booking requests

string
optional Example : "823904318230192730192"

remainingSeats Remaining seats for this flight

integer
optional Example : 10

segmentCodes < FareSegmentCodes

Fare segment codes
optional > array

3.111. FarePrice

XXX

Polymorphism : Composition

Name Description Schema

baseFare
Price
required

discountCode enum (STUDENT,

Discount code
optional SOLDIER)

discountTotal
Price
optional

discounts
Discounts list < CodedPrice > array
optional

feeTotal
Price
optional

Paxgateway Confidential Page:220/344

Paxgateway

Name Description Schema

fees
Fees list < CodedPrice > array
optional

nonRefundable
Items Non refundable item list for reissue cases < CodedPrice > array
optional

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

penalties
Penalties list < CodedPrice > array
optional

penaltyTotal
Price
optional

quantity Passenger count for this type

integer
optional Example : 1

remarks
Additional informations < string > array
optional

surchargeTotal
Price
optional

surcharges
Surcharges list < CodedPrice > array
optional

taxTotal
Price
optional

taxes
Taxes list < CodedPrice > array
optional

totalAmount
Price
required

Paxgateway Confidential Page:221/344

Paxgateway

3.112. FareSegmentCodes

Fare segment codes type

Name Description Schema

enum (COCKPIT,
FIRST,
PREMIUM_BUSINESS
cabinClass Cabin class
, BUSINESS,
optional Example : "ECONOMY"
EXECUTIVE_ECONO
MY, PNL, ECONOMY,
PROMO, REGULAR)

desigCode Reservation booking designation code

string
optional Example : "Y"

fareGroup Fare group

string
optional Example : "EXTRA_ESNEK"

fareReference Fare reference code

string
optional Example : "ZDOMEFLX"

3.113. FawryPaymentDetail

FawryPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

Paxgateway Confidential Page:222/344

Paxgateway

Name Description Schema

description
string
optional

fawryReferenc
eID string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentAmou
nt number (double)
optional

paymentCode
string
optional

paymentCurren
cy string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

Paxgateway Confidential Page:223/344

Paxgateway

Name Description Schema

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.114. Feedback

Name Schema

airReservationInfo
AirReservationInfo
optional

creationDate
string (date-time)
optional

feedbackAttachments
< FeedbackAttachment > array
optional

feedbackMessage
string
optional

feedbackOwner
FeedbackOwner
optional

Paxgateway Confidential Page:224/344

Paxgateway

Name Schema

id
integer (int64)
optional

lastModificationDate
string (date-time)
optional

subjectId
integer (int64)
optional

3.115. FeedbackAttachment

Name Schema

attachment
string (byte)
optional

id
integer (int64)
optional

name
string
optional

uploadedDate
string (date-time)
optional

3.116. FeedbackAttachmentRequest

Name Schema

email
string
optional

feedbackAttachmentList
< FeedbackAttachment > array
optional

feedbackId
integer (int64)
optional

Paxgateway Confidential Page:225/344

Paxgateway

3.117. FeedbackOwner

Name Schema

communicationPreferenceId
string
optional

email
string
optional

gender
string
optional

givenName
string
optional

id
string
optional

membershipId
string
optional

middleName
string
optional

mobilePhone
PhoneNumber
optional

surname
string
optional

title
string
optional

3.118. Flight

Flight information type

Polymorphism : Composition

Paxgateway Confidential Page:226/344

Paxgateway

Name Description Schema

arrDateTime Arrival date and time

string (date-time)
optional Example : "01.01.2018 13:35"

arrPort Arrival port code

string
required Example : "ADN"

dateChangeNbr Flight day change number

integer
optional Example : 1

depDateTime Departure date and time

string (date-time)
optional Example : "01.01.2018 13:35"

depPort Departure port code

string
required Example : "ADA"

flightDuration Duration on air in seconds

integer
optional Example : 7200

layoverDuratio
Duration on ground in seconds
n integer
Example : 3600
optional

openFlight Represents if the flight is an open flight

boolean
optional Default : false

segments
Flight segments < Segment > array
optional

timeToDepartu
Time to departure in seconds
re integer
Example : 7200
optional

3.119. FlightAction

FlightAction

Paxgateway Confidential Page:227/344

Paxgateway

Name Schema

arrPort
string
optional

depPort
string
optional

segments
< string > array
optional

3.120. FlightInfo

Name Schema

airline
string
optional

arrPort
string
optional

depDate
string (date)
optional

depPort
string
optional

flightNumber
string
optional

3.121. FlightInformation

Flight Information for Boarding Card

Name Description Schema

airlineCode
Airline code string
optional

Paxgateway Confidential Page:228/344

Paxgateway

Name Description Schema

arrivalDate Arrival date

string (date)
optional Example : "11.11.2018"

arrivalLocation BoardingCardLocatio
optional n

arrivalTime
Arrival time string
optional

departureDate Departure date

string (date)
optional Example : "12.11.2018"

departureLocat
BoardingCardLocatio
ion
n
optional

departureTime
Departure time string
optional

flightNo
Flight no string
optional

3.122. FlightLocation

Flight locations

Name Description Schema

arrPort Arrival port code

string
required Example : "ADN"

depPort Departure port code

string
required Example : "ADA"

3.123. FlightRequest

Flight request

Paxgateway Confidential Page:229/344

Paxgateway

Name Description Schema

arrPort Arrival port code

string
required Example : "ADB"

cabinClass Cabin class filter

string
optional Example : "ECONOMY"

date Flight date

string (date)
required Example : "11.12.2018"

depPort Departure port code

string
required Example : "IST"

3.124. FlightSchedule

Flight Schedule Information Model

Name Description Schema

arrDateTime Arrival Date Time

string
optional Example : "18.03.2019 06:55:00"

depDateTime Departure Date Time

string
optional Example : "18.03.2019 06:55:00"

flightNumber
Flight Number string
optional

3.125. FlightScheduleDate

Flight Schedule Date Model

Name Description Schema

date Schedule Date

string
optional Example : "22.03.2019"

flights < FlightSchedule >

List of schedules flights
optional array

Paxgateway Confidential Page:230/344

Paxgateway

3.126. FlightScheduleRequest

Flight Schedule Request Model

Name Description Schema

arrPort Arrival Port

string
required Example : "AYT"

date Schedule Date

string
required Example : "18.03.2019"

depPort Departure Port

string
required Example : "IST"

3.127. FlightScheduleResponse

Flight Schedule Response Model

Name Description Schema

inbound < FlightScheduleDate

List of departure schedules flights
optional > array

outbound < FlightScheduleDate

List of arrival schedules flights
optional > array

3.128. FlightStatus

Flight status response segment

Name Description Schema

arrDate Arrival date

number (date)
optional Example : "22.04.2019"

arrPort Arrival airport code

string
optional Example : "ADA"

Paxgateway Confidential Page:231/344

Paxgateway

Name Description Schema

delayTime Delay time

number
optional Example : 60.0

depDate Departure date

number (date)
optional Example : "21.04.2019"

depPort Departure airport code

string
optional Example : "IST"

equipType Equipment type

string
optional Example : "A320-232 / 180Y"

flightNumber Flight number

string
optional Example : "2490"

remarks Remark
< string > array
optional Example : "Reservation"

3.129. FlightStatusByNumberRequest

Flight status by flight number request

Name Description Schema

airlineCode Airline code

string
required Example : "8Q"

date
Example : "25.04.2019" number (date)
required

flightNumber Flight number

string
required Example : "016"

3.130. FlightStatusByPortRequest

Flight status by airport request

Paxgateway Confidential Page:232/344

Paxgateway

Name Description Schema

arrPort Arrival airport code

string
optional Example : "IST"

date Request search date

number (date)
required Example : "21.04.2019"

depPort Departure airport code

string
required Example : "ADA"

3.131. FlightStatusDate

Flight status date response item

Name Description Schema

date
Example : "25.04.2019" number (date)
optional

flights
Flight status date item < FlightStatus > array
optional

3.132. FlightStatusResponse

Flight status response

Name Description Schema

inbound < FlightStatusDate >

Arrival flight status date segment list
optional array

outbound < FlightStatusDate >

Departure flight status date segment list
optional array

3.133. GeneralParameters

General parameters service model

Paxgateway Confidential Page:233/344

Paxgateway

Name Description Schema

ageLimits < AgeLimitResponse

List of age limits
optional > array

airline
Example : "8Q" string
optional

cabinClasses
< string > array
optional

currencies
Currencies
optional

disallowedTrip
TypesInCheape List of trip types which are not allowed in the cheapest
< string > array
stFlights flights service
optional

ibePayLater can ibe clients do pay later?

boolean
optional Example : true

languages
Languages
optional

mobilePayLater can mobile clients do pay later?

boolean
optional Example : true

nameTitles
< string > array
optional

paxCount
Example : 10 integer
optional

tripTypes
List of trip types < string > array
optional

3.134. GetFeedbackRequest

Paxgateway Confidential Page:234/344

Paxgateway

Name Schema

email
string
optional

feedbackId
integer (int64)
optional

3.135. GiftCardPayment

Gift card payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

false
false string
optional

paymentOptio
nId Unique id of payment option string
required

phone
Phone string
optional

3.136. GirogatePayment

Girogate payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

Paxgateway Confidential Page:235/344

Paxgateway

Name Description Schema

countryCode
Country code string
optional

holder
Holder string
optional

paymentOptio
nId Unique id of payment option string
required

3.137. GirogatePaymentDetail

GirogatePaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

availableCount
ryCodeList < string > array
optional

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

cardHolderNa
me string
optional

description
string
optional

Paxgateway Confidential Page:236/344

Paxgateway

Name Description Schema

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

selectedCountr
yCode string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

Paxgateway Confidential Page:237/344

Paxgateway

Name Description Schema

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.138. GovernmentReceiptPaymentDetail

GovernmentReceiptPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

govInformation
string
optional

govReceiptHol
der Passenger
optional

govReceiptId
string
optional

Paxgateway Confidential Page:238/344

Paxgateway

Name Description Schema

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

Paxgateway Confidential Page:239/344

Paxgateway

Name Description Schema

transactionFee
Applies Example : true boolean
optional

3.139. HesCodeRequired

Response model for the HES code requirement.

Name Description Schema

hesRequired
Simple boolean flag for the HES code requirement. boolean
optional

3.140. IatciCheckInInformation

Iatci Check-in information

Name Description Schema

airline Airline code

string
optional Example : "8Q"

arrDateTime Arrival date and time

string (date-time)
optional Example : "01.01.2018 13:35"

arrPort Arrival port code

string
optional Example : "IST"

depDateTime Departure date and time

string (date-time)
optional Example : "01.01.2018 13:35"

depPort Departure port code

string
optional Example : "ADB"

flightNumber Flight number

string
optional Example : "2490"

Paxgateway Confidential Page:240/344

Paxgateway

3.141. InitializePaymentRequest

Initialize Payment request model

Name Description Schema

loyaltyRedemp
tionPayment LoyaltyPayment
optional

operation
OperationType
optional

otherPayment
OtherPayment
optional

productNo
Example : "ZWOQ6B" string
optional

3.142. InitializePaymentResponse

Initialize Payment response model

Name Description Schema

referenceId
Example : "1234-1234123-4545" string
optional

url Example : "https://xyz.com/ref?=1234-2134-

string
optional 1234-1234"

3.143. InlineFormPaymentParameter

InlineFormPaymentParameter

Name Schema

inlineFormJSONRequestParams
string
optional

Paxgateway Confidential Page:241/344

Paxgateway

Name Schema

inlineFormJSONResponseParams
string
optional

3.144. Insurance

Base Insurance Model

Name Description Schema

policyCode
Example : "DOM-BASIC" string
optional

3.145. InsuranceDetail

Insurance Details

Polymorphism : Composition

Name Description Schema

description
Example : "DOMESTIC BASIC INSURANCE" string
optional

endDate End date

string (date)
optional Example : "11.11.2019"

nationalIdRestr
iction boolean
optional

policyCode
Example : "DOM-BASIC" string
optional

policyNumber
string
optional

prices < PricePerPassenger

optional > array

Paxgateway Confidential Page:242/344

Paxgateway

Name Description Schema

selected
boolean
optional

startDate Start date

string (date)
optional Example : "11.11.2018"

3.146. InsurancePassenger

Insurance Passenger Model(with IIN field)

Name Description Schema

passengerIIN IIN information should be 12 char

string
optional Example : "123456789123"

passengerId
Example : "123456789" string
optional

3.147. Invoice

Common Invoice model

Name Schema

companyInvoice
CompanyInvoice
optional

personalInvoice
PersonalInvoice
optional

3.148. InvoiceInfo

InvoiceInfo

Paxgateway Confidential Page:243/344

Paxgateway

Name Schema

balance
number (double)
optional

currency
string
optional

invoiceByParentSr
boolean
optional

invoiceId
string
optional

invoiceNumber
number (long)
optional

invoiceReference
string
optional

srName
string
optional

stockBalance
number (long)
optional

3.149. InvoiceLoginRequest

Login request for invoice services

Name Description Schema

password Login password

string
optional Example : "123456"

username Login username

string
optional Example : "8Q_SEND_DATA"

3.150. InvoiceLoginResponse

Invoice login response

Paxgateway Confidential Page:244/344

Paxgateway

Name Description Schema

Session ID
sessionId
Example : "98AE3E57-6BB6-4875-ACA9- string
optional
8DE58CF445D7"

3.151. InvoiceViewItem

Invoice view item

Name Description Schema

data
List of returned data in bytes < string (byte) > array
optional

docNumber Document number

string
optional Example : "8QS2410044427"

docType Document type

string
optional Example : "FLIGHT"

pnrNumber Pnr number

string
optional Example : "R8J8C6"

ticketNumber Ticket number

string
optional Example : "0662410044427"

type Invoice type

string
optional Example : "SELL"

UUID
uuid
Example : string
optional
"7896130B8ED205D7E0539A0201812D51"

3.152. InvoiceViewRequest

Invoice view request

Paxgateway Confidential Page:245/344

Paxgateway

Name Description Schema

language Requested language

string
optional Example : "tr"

parameter Request parameters

string
optional Example : "owner=IBE"

pnrList
List of pnr number < string > array
optional

Token, acquired by InvoiceLoginResponse

token
Example : "98AE3E57-6BB6-4875-ACA9- string
optional
8DE58CF445D7"

type
Invoice type string
optional

3.153. InvoiceViewResponse

Invoice view response

Name Description Schema

viewItems < InvoiceViewItem >

List of InvoiceViewItem
optional array

3.154. Itinerary

Itinerary

Name Description Schema

segments
List of segments < Segment > array
optional

3.155. Journey

Flight and fare information

Paxgateway Confidential Page:246/344

Paxgateway

Name Description Schema

fares
Flight fares < Fare > array
required

flights
Flights < Flight > array
required

outdated Represents if the flight is outdated or not

boolean
optional Example : false

3.156. JourneysByDate

Founded flights for date

Name Description Schema

date Flight date

string (date)
required Example : "11.11.2018"

directionDates
List of dates for vayant fares < string (date) > array
optional

displayContain
ers Display container name list < string > array
optional

journeys
Founded journeys for date < Journey > array
optional

lowestPrice
Price
required

packageNames
Bundle name list < string > array
optional

3.157. KioskArrivalCity

Arrival City model for kiosks

Paxgateway Confidential Page:247/344

Paxgateway

Name Description Schema

city
Example : "KHI" string
optional

cityName
Example : "Karachi" string
optional

country
Example : "PK" string
optional

countryName
Example : "Pakistan" string
optional

3.158. KioskArrivalCountry

Arrival Country model for kiosks

Name Description Schema

country
Example : "PK" string
optional

countryName
Example : "Pakistan" string
optional

3.159. KioskArrivalPort

Arrival Port model for kiosks

Name Description Schema

city
Example : "KHI" string
optional

cityName
Example : "Karachi" string
optional

code
Example : "KHI" string
optional

Paxgateway Confidential Page:248/344

Paxgateway

Name Description Schema

country
Example : "PK" string
optional

countryName
Example : "Pakistan" string
optional

portName
Example : "Karachi" string
optional

3.160. KioskArrivalPortsResponse

kiosk arrival ports service response

Name Description Schema

arrivalCities < KioskArrivalCity >

Arrival Cities List
optional array

arrivalCountrie
< KioskArrivalCountry
s Arrival Countries List
> array
optional

arrivalPorts < KioskArrivalPort >

Arrival Ports List
optional array

3.161. KioskAvailablePassengersRequest

Kiosk Available Passengers Request Model

Name Description Schema

bookingId Unique Booking Id ( PNR )

string
optional Example : "ABC123"

expectedSeat
seats assigned to the return value? boolean
optional

Paxgateway Confidential Page:249/344

Paxgateway

Name Description Schema

name
Passenger Name string
optional

segmentId
Segment ID string
optional

surname
Passenger Surname string
optional

3.162. Language

Basic language model

Name Description Schema

code
Example : "TR" string
optional

name
Example : "Türkçe" string
optional

3.163. Languages

Supported and default languages

Name Description Schema

defaultLanguag
e Language
optional

values
Supported languages < Language > array
required

3.164. LocationInfo

Paxgateway Confidential Page:250/344

Paxgateway

Name Description Schema

cityCode
City code string
required

cityName
City name string
optional

country
Country string
optional

countryName
County name string
optional

portCode
Port code string
required

portName
Port name string
optional

terminal
Terminal string
optional

3.165. LocationType

PortsOfCountry service response location information model

Name Description Schema

codeContext
code context string
optional

locationCode
location code string
optional

locationName
location name string
optional

Paxgateway Confidential Page:251/344

Paxgateway

Name Description Schema

locationNameL
anguage language of location name string
optional

3.166. LoyaltyPayment

InitializePayment service starting with ff point

Name Description Schema

amountInLocal
Currency Amount in local currency number (double)
optional

ffAmount
Amount number (double)
optional

ffPoint
Loyalty points number (double)
optional

totalMiles
Member Total Miles number (double)
optional

3.167. LoyaltyRedemptionDetail

Loyalty redemption Detail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

Paxgateway Confidential Page:252/344

Paxgateway

Name Description Schema

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

membershipID
string
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

Paxgateway Confidential Page:253/344

Paxgateway

Name Description Schema

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.168. LoyaltyRedemptionPayment

Loyalty redemption payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

amountInLocal
Currency Amount in local currency number (double)
optional

ffPoint
Loyalty points number (double)
optional

paymentOptio
nId Unique id of payment option string
required

3.169. ManageBooking

Booking with carousel rule sets

Paxgateway Confidential Page:254/344

Paxgateway

Polymorphism : Composition

Name Description Schema

arrangerInfo
Arranger
optional

bookingCreate
Booking created date
Date string (date-time)
Example : "01.01.2018 13:35"
optional

bookingId Unique Booking Id ( PNR )

string
optional Example : "ABC123"

contacts
Contact informations for booking < Contact > array
optional

flights
Booking flights < Flight > array
optional

hesRequired check HES code requirement

boolean
optional Example : false

insurance
Insurance
optional

manageBookin
ManageBookingOper
gActions
ation
optional

needPayment Booking need payment

boolean
optional Example : false

package
Package
optional

passengers
Passenger informations for booking < Passenger > array
optional

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

Paxgateway Confidential Page:255/344

Paxgateway

Name Description Schema

priceDetails
Price Details < PriceDetail > array
optional

priceOverview
PriceOverview
optional

refundPayment <
AmountList refund amount list of the booking RefundPaymentAmo
optional unt > array

refundPriceOve
RefundPriceOvervie
rview
w
optional

specialRequest
s SpecialRequests
optional

<
ticketList
Passenger List Based On TicketList PassengerListBasedO
optional
nTicket > array

ticketTimeLimit Ticket expire time

string (date)
optional Example : "01.01.2018 13:35"

enum (ONE_WAY,
MULTI_DIRECTIONAL
, INBOUND_OPEN,
tripType
Trip Type ROUND_TRIP,
optional
OUTBOUND_OPEN,
INBOUND_OUTBOU
ND_OPEN)

3.170. ManageBookingAction

Common fields of Allowed and Secured Action

Paxgateway Confidential Page:256/344

Paxgateway

Name Description Schema

cancelCheckin show cancel checkin option to carousel

boolean
optional Example : true

cancelCheckinD
etails SegmentAction
optional

cancelFlight
CancelFlightAction
optional

cancelReservati
show cancel reservation to carousel
on boolean
Example : true
optional

changeContact show change contact option to carousel

boolean
optional Example : true

changeFlight
ChangeFlightAction
optional

3.171. ManageBookingOperation

Manage Booking actions

Name Schema

allowedActions
AllowedAction
optional

securedActions
SecuredAction
optional

3.172. MasterpassPayment

Masterpass Payment

Polymorphism : Composition

Paxgateway Confidential Page:257/344

Paxgateway

Name Description Schema

amount
Payment amount number (double)
required

paymentOptio
nId Unique id of payment option string
required

3.173. McoInvPayment

MCO invoice payment

Polymorphism : Composition

Name Description Schema

amount
Payment amount number (double)
required

id
ID string
optional

paymentOptio
nId Unique id of payment option string
required

3.174. MeasureUnit

Units of measure

Name Schema

firstMaxDimension
Dimension
optional

maxAllowedQuantity
number
optional

Paxgateway Confidential Page:258/344

Paxgateway

Name Schema

measureUnitCode
string
optional

measureUnitQuantity
number
optional

minAllowedQuantity
number
optional

secondMaxDimension
Dimension
optional

servedWeight
number
optional

3.175. MemberActivity

Flights of a member

Name Description Schema

travelActivities < AirTravelActivity >

List of travel activities
required array

3.176. MemberAddress

Member Address

Polymorphism : Composition

Name Description Schema

active Is active address

boolean
optional Example : true

bldgRoom
string
optional

Paxgateway Confidential Page:259/344

Paxgateway

Name Description Schema

cityCode
City code string
optional

cityName
City name string
optional

countryCode
Country code string
optional

countryName
Country name string
optional

formatted
Is address formatted boolean
optional

id Member Address Id
number (long)
optional Example : 12345.0

lines
Address lines < string > array
optional

postalCode
Postal code string
optional

preferred Is preferred
boolean
optional Example : true

shareMarketIn
d boolean
optional

stateProvince
State province string
optional

streetNumber
Street number string
optional

useType
Use type string
optional

Paxgateway Confidential Page:260/344

Paxgateway

3.177. MemberCardDataResponse

Member card information model

Name Description Schema

award miles points double

awardMiles
Minimum value : 0 number
optional
Example : 125.02

expireDate Expire Date

string
optional Example : "18.03.2019"

expireDateOnC
Expire Date On Card
ard string
Example : "18.03.2019"
optional

issueDate Expire Date On Card

string
optional Example : "18.03.2019"

middleName Member Middle Name

string
optional Example : "Junior"

name Member Name

string
optional Example : "Walter"

surname Member Sur Name

string
optional Example : "White"

tierLevel Tier Level

string
optional Example : "WHITE"

Tier points double

tierPoints
Minimum value : 0 number
optional
Example : 125.02

title Member Title

string
optional Example : "Dr."

Paxgateway Confidential Page:261/344

Paxgateway

Name Description Schema

totalMilesSince Total Miles Since Enrollment double

Enrollment Minimum value : 0 number
optional Example : 125.02

totalRedeemed Total Redeemed Miles double

Miles Minimum value : 0 number
optional Example : 125.02

3.178. MemberEmail

Member Email Type

Polymorphism : Composition

Name Description Schema

active Is active email

boolean
optional Example : true

email E-mail
string
optional Example : "aaa@bbb.com"

id Email Id
number (long)
optional Example : 12345.0

preferred preferred (true)

boolean
optional Example : true

useType Use type

string
optional Example : "PERSONAL"

3.179. MemberPersonalInfo

Member personal info

Paxgateway Confidential Page:262/344

Paxgateway

Name Description Schema

code
Code string
optional

description
Description string
optional

multipleChoice
Selectable Is multiple choice selectable boolean
optional

notes
Notes string
optional

notesAccepted
Accepted notes boolean
optional

personalInfoDe <
tails List of personal info details MemberPersonalInfo
optional Detail > array

3.180. MemberPersonalInfoDetail

Member personal info detail

Name Description Schema

code
Code string
optional

description
Description string
optional

selected
Is selected boolean
optional

3.181. MemberPhoneNumber

Member Phone Number

Paxgateway Confidential Page:263/344

Paxgateway

Polymorphism : Composition

Name Description Schema

active Is active phone number

boolean
optional Example : true

areaCode Area code (505)

string
optional Example : "541"

countryCode Country code (90)

string
optional Example : "90"

id Member Phone Number Id

number (long)
optional Example : 12345.0

number Phone number (4678321)

string
optional Example : "5576904"

preferred preferred (true)

boolean
optional Example : true

useType Use Type('MOBILE')

string
optional Example : "MOBILE"

3.182. MemberProfile

Member profile

Polymorphism : Composition

Name Description Schema

addressList < MemberAddress >

List of addresses
optional array

awardMiles
Award miles number
optional

birthDate Birth date

string (date)
optional Example : "11.01.1995"

Paxgateway Confidential Page:264/344

Paxgateway

Name Description Schema

consentAddres
Consent Address
s boolean
Example : true
optional

consentEmail Consent Email

boolean
optional Example : true

consentFax Consent Fax

boolean
optional Example : true

consentSms Consent Sms

boolean
optional Example : true

emails < MemberEmail >

List of e-mails
optional array

enrollmentSou
enrollment source
rce string
Example : "INTERNET"
optional

gender
Gender string
optional

givenName Firstname
string
optional Example : "JOHN"

knownTraveler
Number Known Traveler Number string
optional

language Language
string
optional Example : "TR"

maritalStatus
Marital status string
optional

marriageDate
Marriage date string (date)
optional

Paxgateway Confidential Page:265/344

Paxgateway

Name Description Schema

membershipId
Unique id of the member string
optional

middleName Middlename
string
optional Example : "SMITH"

nationalId National ID
string
optional Example : "11111111111"

nationality Nationality
string
optional Example : "TR"

passportExpiry
Date Passport expire date string (date)
optional

passportNo
Passport no string
optional

personalInfoLis <
t MemberPersonalInfo
optional > array

<
phoneNumbers
List of phone numbers MemberPhoneNumb
optional
er > array

redeemedMiles
Redeemed miles number
optional

redressNumber
Redress Number string
optional

referringMemb
ershipID Referring member id string
optional

Paxgateway Confidential Page:266/344

Paxgateway

Name Description Schema

remark
Remark string
optional

signupDate Member signup date

string
optional Example : "11.03.2019"

status Member status

string
optional Example : "AC"

surname Lastname
string
optional Example : "SNOW"

tierMile
TierMile
optional

title Title
string
optional Example : "DR"

3.183. MemberStatement

Member statement

Name Description Schema

currentPoint
Current point number
optional

cutDate Cut date

string (date)
optional Example : "11.11.2019"

expiringMiles < MilesToBeExpired >

List of MilesToBeExpired
optional array

statementRefId
string
optional

3.184. MemberStatementDetail

Member statement detail type

Paxgateway Confidential Page:267/344

Paxgateway

Name Description Schema

arrPort Arrive port code

string
optional Example : "IST"

currentPoint
Current point number
optional

date Activity date (dd.MM.yyyy hh:mm formatted date)

string (date-time)
optional Example : "11.11.2019 12:00"

depPort Departure port code

string
optional Example : "GZT"

explanation
Explanation string
optional

3.185. MemberTransaction

Member transaction type

Name Description Schema

arrPort Arrive port code

string
optional Example : "IST"

arrivalDate Arrival date (dd.MM.yyyy hh:mm)

string (date-time)
optional Example : "15.09.2018 12:55"

bookingId Booking reference id

string
optional Example : "KJ4554IOK"

depPort Departure port code

string
optional Example : "GZT"

departureDate Arrival date (dd.MM.yyyy hh:mm)

string (date-time)
optional Example : "15.09.2018 10:45"

explanation
Extra notes string
optional

Paxgateway Confidential Page:268/344

Paxgateway

Name Description Schema

miles Miles
number
optional Example : 897.0

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

tierMiles Miles
number
optional Example : 897.0

type enum (ACTIVITY,

Transaction Type
optional REDEMPTION)

3.186. MemberTransactionListRequest

Transacrion start and end date

Name Description Schema

end
End sate (dd.MM.yyyy) string
optional

start
Start date (dd.MM.yyyy) string
optional

3.187. MilesPrice

Miles price type

Name Description Schema

code Code
string
optional Example : "KJ6N7JK"

miles Miles
number
optional Example : 823.0

price
Price
optional

Paxgateway Confidential Page:269/344

Paxgateway

3.188. MilesToBeExpired

Miles to be expired type

Name Description Schema

expiryDate Expiration date

string (date)
optional Example : "12.12.2019"

miles
Amount of the miles to be expired at expireDate number
optional

3.189. MiscChargeOrderDetail

MiscChargeOrderDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

availableInvolic
eList < InvoiceInfo > array
optional

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

Paxgateway Confidential Page:270/344

Paxgateway

Name Description Schema

mcoNumber
string
optional

originalIssueAt
OriginalIssueAttribut
tributes
es
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

Paxgateway Confidential Page:271/344

Paxgateway

Name Description Schema

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.190. MsPiaPaymentDetail

MsPiaPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

Paxgateway Confidential Page:272/344

Paxgateway

Name Description Schema

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.191. NewPackagesRequest

NewPackagesRequest

Type : < NewPackagesRequest > array

NewPackagesRequest

Paxgateway Confidential Page:273/344

Paxgateway

Name Schema

packageId
string
optional

segmentId
string
optional

3.192. OperatingAirline

OperatingAirline

Name Schema

code
string
optional

codeContext
string
optional

companyFullName
string
optional

companyShortName
string
optional

flightNumber
string
optional

3.193. OperationPurpose

Operation purpose

Type : enum (CALCULATE, PERSIST)

3.194. OperationType

Purpose of the payment

Type : enum (SellPnr, SellSsr, Reissue, CheckIn, PointSale, SellGroupPnr)

Paxgateway Confidential Page:274/344

Paxgateway

3.195. OriginalIssueAttributes

ExternallyHandledPaymentTool

Name Description Schema

originalIssueDa
te Example : "01.01.2018 13:35" string (date-time)
optional

originalIssueIA
TA string
optional

originalIssuePla
ce string
optional

originalPaymen
tForm string
optional

originalTicketN
umber string
optional

3.196. OtherPayment

InitializePayment service starting with normal pay

Name Description Schema

amount
Amount number (double)
optional

3.197. Package

Additional fare package type

Paxgateway Confidential Page:275/344

Paxgateway

Polymorphism : Composition

Name Description Schema

category Package category

string
optional Example : "CAT2"

currency Currency ISO code

string
required Example : "TRY"

id Unique id of the fare package

string
optional Example : "PRE_DOM_FLX$$PRE_DOM_FLX"

name i18n key of name of the fare package

string
optional Example : "PRE_DOM_FLX_PRE_DOM_FLX"

packagePrice
PackagePrice
optional

redeemedMiles
Equivalent miles number
optional

subPackages < SubPackagePrice >

Subpackages
optional array

Amount
value
Minimum value : 0 number (money)
required
Example : 125.02

3.198. PackagePrice

Package Price information

Name Schema

discountAmount
< Price > array
optional

packageAmount
< Price > array
optional

Paxgateway Confidential Page:276/344

Paxgateway

Name Schema

packageAmountWithoutDiscount
< Price > array
optional

3.199. Passenger

Passenger informations

Name Description Schema

address
Passenger Address List < Address > array
optional

birthDate Passenger birth date

string (date)
optional Example : "28.12.1972"

country Passenger origin country

string
optional Example : "TR"

documents
Passenger id document information < Document > array
optional

gender
Passenger gender enum (M, F)
optional

givenName Passenger first name

string
optional Example : "John"

hasInfant This field only can be true for ALDT passengers.

boolean
optional Example : false

id Unique ID for Passenger

string
optional Example : "1234546"

membershipId Loyalty services id

string
optional Example : "1234545"

middleName Passenger middle name

string
optional Example : "Smith"

Paxgateway Confidential Page:277/344

Paxgateway

Name Description Schema

parentId If Passenger is infant or child which adult is responsible

integer
optional Example : 12345

passengerIIN IIN information should be 12 char(not required)

string
optional Example : "123456789123"

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

socialSecurityN
Social Security Number
o string
Example : "1234545"
optional

surname Passenger surname

string
optional Example : "Doe"

title Passenger title selected from Title service results.

string
optional Example : "Doctor"

3.200. PassengerDcsInformation

Passenger DCS information

Polymorphism : Composition

Name Description Schema

birthDate Birthdate
number (date)
optional Example : "01.01.1972"

bookingGroupC
ode Booking group code string
optional

bookingRefere
nceID Booking reference ID string
optional

Paxgateway Confidential Page:278/344

Paxgateway

Name Description Schema

documents
Passenger document informations < Document > array
optional

email
E-mail string
optional

if this property is true, seat selection is not allowed for this

freeSeating
passenger in the check-in flow boolean
optional
Example : false

gender
Gender string
optional

givenName
Firstname string
optional

gsm
PhoneNumber
optional

hasInfant
boolean
optional

id
string
optional

isBoardingCard
Printable boolean
optional

isChecked
boolean
optional

isElligibleForCh
eckin boolean
optional

membershipId
Membership ID string
optional

Paxgateway Confidential Page:279/344

Paxgateway

Name Description Schema

nationality
Nationality string
optional

parentId
string
optional

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

postCode
Post code string
optional

profession
Profession string
optional

seatInfo
< Seat > array
optional

socialSecurityN
o Social security number string
optional

surname
Surname string
optional

3.201. PassengerInformation

Passenger information

Name Description Schema

addressList
List of addresses < Address > array
optional

documentList
List of documents < Document > array
optional

Paxgateway Confidential Page:280/344

Paxgateway

Name Description Schema

passengerInfor
PassengerDcsInform
mation
ation
optional

3.202. PassengerListBasedOnTicket

Basic PassengerListBasedOnTicket model

Name Schema

passengerId
string
optional

tickets
< string > array
optional

3.203. PassengerListBasedOnVoucher

Basic PassengerListBasedOnVoucher model

Name Schema

passengerId
string
optional

vouchers
< Voucher > array
optional

3.204. PassengerSeatInformation

Passenger seat information type

Name Schema

passenger
PassengerDcsInformation
optional

Paxgateway Confidential Page:281/344

Paxgateway

Name Schema

seat
SeatMapSeat
optional

3.205. PassengerSimpleInformation

Passenger Simple information

Name Description Schema

birthDate Birthdate
number (date)
optional Example : "01.01.1972"

gender
Gender string
optional

givenName
Firstname string
optional

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

surname
Surname string
optional

3.206. PassengersRequest

Passengers request

Name Description Schema

contacts
Contact informations, overrides existing contacts < Contact > array
optional

passengers
Passenger informations < Passenger > array
optional

Paxgateway Confidential Page:282/344

Paxgateway

3.207. PaymentDetail

Payment Detail model for GET /ticket service

Name Description Schema

bkmPayment
BkmExpressDetail
optional

bookOnHoldPa
< BookOnHoldDetail
ymentList List of Book On Hold
> array
optional

cashPayment
CashDetail
optional

chequePaymen
ChequePaymentDeta
t
il
optional

creditCardPay
< CreditCardDetail >
mentList List of Credit Carts
array
optional

directDebitPay
ment DirectDebitDetail
optional

emdPayment
EmdPaymentDetail
optional

externallyHand
ExternallyHandledPa
ledPayment
ymentDetail
optional

fawryPayment
FawryPaymentDetail
optional

Paxgateway Confidential Page:283/344

Paxgateway

Name Description Schema

girogatePayme <
ntList List of Girogate GirogatePaymentDet
optional ail > array

governmentRe
<
ceiptPaymentLi
List of Girogate GovernmentReceiptP
st
aymentDetail > array
optional

loyaltyRedemp
LoyaltyRedemptionD
tionPayment
etail
optional

miscChargeOrd
MiscChargeOrderDet
er
ail
optional

msPiaPayment
MsPiaPaymentDetail
optional

raveAccountPa
RaveAccountPaymen
yment
tDetail
optional

sadadPayment
SadadPaymentDetail
optional

sofort
SofortDetail
optional

turkcellCuzdan
TurkcellCuzdanDetail
optional

3.208. PaymentOption

Payment option, paymentOptionID is used in payment request

Paxgateway Confidential Page:284/344

Paxgateway

Name Description Schema

airlineDataReq
uired boolean
optional

avs
Is AVS boolean
optional

bankIca
Bank ICA string
optional

captureCardInf
o Capture card info boolean
optional

countryCodes
List of country codes < string > array
optional

encryptionKey
string
optional

encryptionReq
uired boolean
optional

installment
Installment integer (int64)
optional

installmentGro
up Installment group string
optional

installmentText
Installment text string
optional

logoUrl
Logo url string
optional

Paxgateway Confidential Page:285/344

Paxgateway

Name Description Schema

enum (CreditCard,
BkmExpress,
LoyaltyRedemption,
Girogate,
method
Payment method ElectronicDelivery,
optional
Cash, Mco, Invoice,
Chupop, Masterpass,
Cheque, Dummypos,
Sadad, GiftCard)

order
Order number integer (int64)
required

paymentOptio
nId Used in payment request string
optional

enum (Garanti, Ykb,

Asseco, Loyalty,
BkmExpress,
Computop,
Masterpass, Hititpos,
psp
PSP Cash, McoInv,
optional
Payhost, StsPayone,
Cheque, Rave,
DummyPos, Sadad,
Ingenico, Gtpay,
GiftCard)

subType
Sub type string
optional

text
Text string
optional

Paxgateway Confidential Page:286/344

Paxgateway

Name Description Schema

toolType
List of tool types < string > array
optional

enum (CC, CA, MCO,

type INV, EDD, FF, GGP,
Type
optional UP, MP, CQ, DP, SDD,
GC)

3.209. PaymentRequest

Base class of payment request types

Name Schema

bkmPayment
BkmPayment
optional

bookOnHoldPayment
BookOnHoldPayment
optional

cashPayment
CashPayment
optional

chequePayment
ChequePayment
optional

chupopPayment
ChupopPayment
optional

creditCardPayment
CreditCartPayment
optional

dummyPosPayment
DummyPosPayment
optional

electronicDocumentDeliveryPayment
ElectronicDocumentDeliveryPayment
optional

Paxgateway Confidential Page:287/344

Paxgateway

Name Schema

giftCardPayment
GiftCardPayment
optional

girogatePayment
GirogatePayment
optional

loyaltyRedemptionPayment
LoyaltyRedemptionPayment
optional

masterpassPayment
MasterpassPayment
optional

mcoInvPayment
McoInvPayment
optional

3.210. PaymentRequestBase

Name Description Schema

amount
Payment amount number (double)
required

paymentOptio
nId Unique id of payment option string
required

3.211. PersonalInvoice

Personal Invoice Type

Name Description Schema

address
Address string
optional

name
Person Name string
optional

Paxgateway Confidential Page:288/344

Paxgateway

Name Description Schema

socialSecurityN
o Person social security number string
optional

surname
Person Surname string
optional

3.212. PhoneNumber

Phone number

Name Description Schema

areaCode Area code (505)

string
optional Example : "541"

countryCode Country code (90)

string
optional Example : "90"

number Phone number (4678321)

string
optional Example : "5576904"

preferred preferred (true)

boolean
optional Example : true

useType Use Type('MOBILE')

string
optional Example : "MOBILE"

3.213. Port

Port definition

Name Description Schema

city City code

string
required Example : "IST"

Paxgateway Confidential Page:289/344

Paxgateway

Name Description Schema

cityName City Name

string
required Example : "Istanbul"

code Port code

string
required Example : "SWT"

country Country code

string
required Example : "TR"

countryName Country Name

string
required Example : "Turkey"

portName Port Name

string
required Example : "Istanbul Havaalani"

3.214. PortList

Port list information model

Name Description Schema

port
port information list < PortType > array
optional

3.215. PortMatrix

Port Matrix definition

Name Description Schema

arrPorts
Arrival ports < arrPorts > array
required

carrier Airline code

string
required Example : "Hitit Air"

port Departure port code

string
required Example : "SWT"

Paxgateway Confidential Page:290/344

Paxgateway

arrPorts

Name Description Schema

eligiblePax < enum (ADLT, CHLD,

Eligible passenger types
optional SLDR) > array

port Arrival port code

string
required Example : "ADA"

segmentType enum (DIRECT,

Segment type
required CONECTED)

3.216. PortType

Port list model

Polymorphism : Composition

Name Description Schema

codeContext
code context string
optional

icaoCode
international currency code string
optional

localTime local date and time

string (date-time)
optional Example : "01.01.2018 13:35"

locationCode
location code string
optional

locationName
location name string
optional

locationNameL
anguage language of location name string
optional

Paxgateway Confidential Page:291/344

Paxgateway

3.217. Price

Price information

Polymorphism : Composition

Name Description Schema

currency Currency ISO code

string
required Example : "TRY"

redeemedMiles
Equivalent miles number
optional

Amount
value
Minimum value : 0 number (money)
required
Example : 125.02

3.218. PriceBase

Base price information

Name Description Schema

currency Currency ISO code

string
required Example : "TRY"

Amount
value
Minimum value : 0 number (money)
required
Example : 125.02

3.219. PriceDetail

yyyy

Polymorphism : Composition

Paxgateway Confidential Page:292/344

Paxgateway

Name Description Schema

baseFare
Price
required

discountTotal
Price
optional

discounts
Discounts list < CodedPrice > array
optional

feeTotal
Price
optional

fees
Fees list < CodedPrice > array
optional

isSsr
Example : true boolean
optional

nonRefundable
Items Non refundable item list for reissue cases < CodedPrice > array
optional

passenger
Passenger
optional

penalties
Penalties list < CodedPrice > array
optional

penaltyTotal
Price
optional

remarks
Additional informations < string > array
optional

ssr
SimpleSSR
optional

surchargeTotal
Price
optional

Paxgateway Confidential Page:293/344

Paxgateway

Name Description Schema

surcharges
Surcharges list < CodedPrice > array
optional

taxTotal
Price
optional

taxes
Taxes list < CodedPrice > array
optional

totalAmount
Price
required

3.220. PriceFreezingOption

Price freezing option type

Name Description Schema

code
Price freezing code string
optional

duration
Duration in hour format string
optional

prices < PricePerPassenger

List of prices
optional > array

referenceId
Price freezing reference ID string
optional

3.221. PriceOverview

Booking Prices

Name Schema

totalAmount
< Price > array
optional

Paxgateway Confidential Page:294/344

Paxgateway

Name Schema

totalBaseFare
< Price > array
optional

totalDiscount
< Price > array
optional

totalFee
< Price > array
optional

totalPenalty
< Price > array
optional

totalServiceCharge
< Price > array
optional

totalSurcharge
< Price > array
optional

totalTax
< Price > array
optional

3.222. PricePerPassenger

Amount per passenger

Name Description Schema

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

price
Price
optional

3.223. PriceResponse

Price Response

Paxgateway Confidential Page:295/344

Paxgateway

Name Description Schema

priceDetails
Price Details < PriceDetail > array
optional

priceOverview
PriceOverview
optional

3.224. PrintTicket

print ticket options

Name Description Schema

available available information for selected action

boolean
optional Example : true

mobileAvailabl
mobile available information for selected action
e boolean
Example : true
optional

showPricing showPricing information for selected action

boolean
optional Example : true

3.225. PspInfo

PspInfo

Name Schema

clientSideKey
string
optional

encryptionType enum (CLIENT_SIDE_ENCRYPTION,

optional SERVER_SIDE_ENCRYTION)

integrationType enum (THREE_D_SECURE, CLIENT_INLINE_FORM,

optional NON_THREE_D_SECURE, CREATE_ORDER)

Paxgateway Confidential Page:296/344

Paxgateway

Name Schema

pspCode
string
optional

pspIdentityCode
string
optional

pspName
string
optional

3.226. PurchasePointsResponse

Name Description Schema

productNo
Product no string
optional

sucess
Is operation successful boolean
optional

3.227. RaveAccountPaymentDetail

RaveAccountPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

Paxgateway Confidential Page:297/344

Paxgateway

Name Description Schema

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

Paxgateway Confidential Page:298/344

Paxgateway

Name Description Schema

transactionFee
Applies Example : true boolean
optional

3.228. ReasonForIssuance

ReasonForIssuance

Name Schema

code
string
optional

explanation
string
optional

subCode
string
optional

3.229. RefundPaymentAmount

Name Description Schema

amount
refund amount Price
optional

code
code of refund amount string
optional

desciption
description of the refund amount string
optional

3.230. RefundPriceOverview

Booking Refund Prices

Paxgateway Confidential Page:299/344

Paxgateway

Name Schema

nonRefundableAmount
< Price > array
optional

refundFromAncillary
< Price > array
optional

refundFromFare
< Price > array
optional

refundFromServiceFee
< Price > array
optional

refundFromSurcharges
< Price > array
optional

refundFromTaxes
< Price > array
optional

refundableAmount
< Price > array
optional

totalAmountPaid
< Price > array
optional

3.231. ReissueRequest

Reissue request

Name Description Schema

<
newSegments
List of new requests, object type is same as /booking/create BookingRequestItem
optional
> array

purpose
OperationPurpose
optional

Paxgateway Confidential Page:300/344

Paxgateway

Name Description Schema

removedSegme
Segment ids to be removed. If this value is undefined or null
nts < string > array
all of the old segments will be replaced with new segments.
optional

3.232. RequiredPointsRequest

Required points service request type

Name Description Schema

amount
Price
optional

bookingId Booking reference id (PNR)

string
optional Example : "KJ46UH3M"

isReissue Should be true in reissue flow

boolean
optional Example : true

3.233. RequiredPointsResponse

Required points service response type

Name Description Schema

amount
Price
optional

amountInLocal
Currency Amount in local currency number
optional

bookingId
PNR number string
optional

isMilesEnough
boolean
optional

Paxgateway Confidential Page:301/344

Paxgateway

Name Description Schema

isPaxFFPActive
boolean
optional

needsToBuyMil
if member is need to buy miles for payment return true else
es boolean
return false
optional

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

requiredMiles
Required miles number
optional

totalMiles
Total miles number
optional

3.234. Reservation

Reservation

Name Description Schema

arranger
Arranger
optional

awardTicket
Is ticket on award boolean
optional

enum (TICKETED,
RESERVED,
bookingStatus Reservation status
CANCELLED,
optional Example : "TICKETED"
ADDITIONAL_PAYME
NT)

contacts
List of contacts < Contact > array
optional

Paxgateway Confidential Page:302/344

Paxgateway

Name Description Schema

creationDate Reservation creation date

string (date)
optional Example : "11.11.2018"

extTransactionI
d Transaction ID string
optional

groupBooking
Group booking boolean
optional

itineraries
< Itinerary > array
optional

nonTicketedEle
mentsExist Payment is required if true boolean
optional

passengers
List of passengers < Passenger > array
optional

referenceIds
List of reference IDs < string > array
optional

smsSaleApplica
ble Is SMS sale applicable boolean
optional

specialRequest
s SpecialRequests
optional

ticketOnDepart
ure Is ticket on departure boolean
optional

ticketTimeLimit
Ticket time limit number
optional

Paxgateway Confidential Page:303/344

Paxgateway

Name Description Schema

travelInsurance
TravelInsurance
optional

warningNotific
ation WarningNotification
optional

3.235. RetrieveBookingRequest

Retrieve booking request

Name Description Schema

bookingId
Booking reference id string
optional

name
Customer name string
optional

Recalculates price of the booking if true, otherwise reads

recalculate
booking from database boolean
optional
Default : false

surname
Customer surname string
optional

3.236. RetrieveCreditCardPaymentOptionsRequest

Returns list of available options for credit cards, should be called if creditCardEnabled value on
RetrievePaymentOptionsResponse has returned true

Name Description Schema

binCode
Bin code string
optional

Paxgateway Confidential Page:304/344

Paxgateway

Name Description Schema

currency
Currency string
required

operation
OperationType
optional

3.237. RetrieveCreditCardPaymentOptionsResponse

Returns list of available options for credit cards, should be called if creditCardEnabled value on
RetrievePaymentOptionsResponse has returned true

Name Description Schema

paymentOptio
< PaymentOption >
ns List of payment options
array
optional

3.238. RetrieveLoyaltyRedemptionPaymentOptionsRequest

Returns list of available options for loyalty redemptions.

Name Description Schema

currency
Currency string
required

3.239. RetrieveLoyaltyRedemptionPaymentOptionsResponse

Returns list of available options for loyalty redemptions.

Name Description Schema

paymentOptio
< PaymentOption >
ns List of payment options
array
optional

Paxgateway Confidential Page:305/344

Paxgateway

3.240. RetrievePaymentOptionsRequest

Returns list of available payment options, also returns paymentOptionID to use in paymentRequest

Name Description Schema

currency
Payment currency type string
required

operation
OperationType
optional

3.241. RetrievePaymentOptionsResponse

Returns list of available payment options, also returns paymentOptionID to use in paymentRequest

Name Description Schema

creditCardEnab
Is credit card enabled
led boolean
Example : false
required

dummyPosEna
Is dummy pos enabled
bled boolean
Example : false
required

paymentOptio
< PaymentOption >
ns List of payment options
array
optional

3.242. RetrievePaymentResultRequest

Retrieve Payment Result Request Model

Name Description Schema

referenceId
Example : "1234-1234123-4545" string
optional

Paxgateway Confidential Page:306/344

Paxgateway

3.243. SSR

Special Request details

Polymorphism : Composition

Name Description Schema

category
string
optional

code SSR code

string
optional Example : "SEAT"

explanation Explanation of Ssr

string
optional Example : "NTBL-NITELIKLI BILET"

free True when SSR is free of charge

boolean
optional Example : false

group SSR Group Code

string
optional Example : "CATERING"

isBundle True when SSR is part of selected bundle

boolean
optional Example : false

needPayment
SSR is need payment boolean
optional

passengerId SSR for passenger

string
optional Example : "123456"

price
Price
optional

segmentId SSR for segment

string
optional Example : "123456"

SSR value. Value format change by ssrType. Like : 25A, 10

selectedValue
Kg, 3 PC etc. string
optional
Example : "25A"

Paxgateway Confidential Page:307/344

Paxgateway

Name Description Schema

sequence
SSR sequence integer
optional

ssrReferenceId Special Request reference id

string
optional Example : "74821097"

ssrType SSR type definition.

string
optional Example : ""

3.244. SadadPaymentDetail

FawryPaymentDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

accountName
string
optional

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

Paxgateway Confidential Page:308/344

Paxgateway

Name Description Schema

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.245. Seat

Seat

Paxgateway Confidential Page:309/344

Paxgateway

Name Description Schema

changeReason
Change reason string
optional

changeType
Change type string
optional

deckLevel
Dock level string
optional

rowNumber
Row number integer
optional

seatInRow
Seat in row string
optional

seatNumber
Seat number string
optional

3.246. SeatDisallowedAttribute

SeatDisallowedAttribute

Name Description Schema

attribute
Example : "EX" string
optional

ssrCodes
< string > array
optional

3.247. SeatDisallowedPerPassenger

SeatDisallowedPerPassenger

Paxgateway Confidential Page:310/344

Paxgateway

Name Description Schema

disallowedSeat
s < string > array
optional

passengerId
Example : "11304014" string
optional

3.248. SeatGroup

Group that contains sell code and price

Name Description Schema

price
Price
optional

sellCode Seat groups based on sell code

string
optional Example : "EX"

3.249. SeatMap

Seat Map for seat selection

Name Description Schema

cabins < SeatMapCabin >

Seat cabin
optional array

disallowedAttri <
butes disallowedAttributes SeatDisallowedAttrib
optional ute > array

disallowedSeat <
sPerPassenger disallowedSeatsPerPassenger SeatDisallowedPerPa
optional ssenger > array

Paxgateway Confidential Page:311/344

Paxgateway

Name Description Schema

parts < SeatMapPart >

Seat parts
optional array

seatGroups
Seat groups < SeatGroup > array
optional

3.250. SeatMapCabin

Cabin definition

Name Description Schema

code Cabin code

string
optional Example : "Y"

rows < SeatMapRow >

cabin seat rows
optional array

type Cabin type

string
optional Example : "ECO"

3.251. SeatMapColumn

Column definition

Name Description Schema

label column label

string
optional Example : "A"

number column number

integer
optional Example : 1

type
Column type enum (SEAT, AISLE)
optional

Paxgateway Confidential Page:312/344

Paxgateway

3.252. SeatMapPart

Airplane seat layout part

Name Description Schema

columns < SeatMapColumn >

Seat map columns
optional array

endingRow
Seat map ending row number (int32)
optional

partNo
Seat map part no string
optional

startingRow
Seat map starting row number (int32)
optional

3.253. SeatMapRow

cabin row definition

Name Description Schema

number Row Number

integer
optional Example : 1

seats < SeatMapSeat >

Seat details
optional array

3.254. SeatMapSeat

Seat definition

Name Description Schema

attribute Seat Attribute

string
optional Example : "EX"

Paxgateway Confidential Page:313/344

Paxgateway

Name Description Schema

colNumber Column number

integer
optional Example : 1

exitSeat is seat exit seat. If true Infant, child passengers not accepted
boolean
optional Example : true

inftAllow is seat exit seat. If true Infant passengers not accepted

boolean
optional Example : true

price
Price
optional

rowNumber Row number

integer
optional Example : 1

seatNumber Seat number

string
optional Example : "1A"

sellCode Additional sell codes. Psoible values EX,WD,MD,FR etc.

string
optional Example : "WD"

status Seat availability status. Possible values FR, BL, BC etc.

string
optional Example : "FR"

type
Column type enum (SEAT, AISLE)
optional

3.255. Section

Name Schema

id
integer (int64)
optional

name
string
optional

Paxgateway Confidential Page:314/344

Paxgateway

3.256. SecuredAction

Secured Options

Polymorphism : Composition

Name Description Schema

cancelCheckin show cancel checkin option to carousel

boolean
optional Example : true

cancelCheckinD
etails SegmentAction
optional

cancelFlight
CancelFlightAction
optional

cancelReservati
show cancel reservation to carousel
on boolean
Example : true
optional

changeContact show change contact option to carousel

boolean
optional Example : true

changeFlight
ChangeFlightAction
optional

3.257. Segment

Segment of a flight

Name Description Schema

aircraft
Aircraft
optional

airline Airline code

string
required Example : "8Q"

Paxgateway Confidential Page:315/344

Paxgateway

Name Description Schema

airlineName Airline name

string
optional Example : "WESTJET"

apisRequired if true, detailed passenger data required for this flight

boolean
optional Example : false

aqqFlightDataR
aqqFlightDataRequired boolean
equired boolean
Example : false
optional

arrDateTime Arrival date and time

string (date-time)
required Example : "01.01.2018 13:35"

arrPort Arrival port code

string
required Example : "IST"

arrTerminal
Arrival terminal string
optional

baggageAllowa
< BaggageAllowance
nce Accepted baggage allowance
> array
optional

dateChangeNbr Flight day change number

integer
optional Example : 1

depDateTime Departure date and time

string (date-time)
required Example : "01.01.2018 13:35"

depPort Departure port code

string
required Example : "ADB"

depTerminal
Departure terminal string
optional

domestic Flight is domestic or international

boolean
required Example : true

Paxgateway Confidential Page:316/344

Paxgateway

Name Description Schema

flightNumber Flight number

string
required Example : "13"

if this property is true, seat selection is not allowed for this

freeSeating
segment in the check-in flow boolean
optional
Example : false

groundDuratio
Duration on ground in secons
n integer
Example : 7200
optional

hasCheckinStat
usPassenger has any checkedin passenger boolean
optional

hasElligiblePass
engerForChecki
has any Elligible Passenger For Checkin boolean
n
optional

Unique id of the segment

id Example :
string
optional "414441x31353439363034313030303030x49535
4x31353439363130313030303030x3851x3133"

journeyDuratio
Duration on air in seconds
n integer
Example : 3600
optional

layoverDuratio
Duration on ground in seconds
n integer
Example : 3600
optional

operatingAirlin
e OperatingAirline
optional

Paxgateway Confidential Page:317/344

Paxgateway

Name Description Schema

remarks
Additional information for segment < string > array
optional

segmentCodes < FareSegmentCodes

Fare segment codes
optional > array

stopLocationLis
< StopLocation >
t Segment contains additional stop locations
array
optional

timeToDepartu
Time to departure date in secons
re integer
Example : 7200
optional

3.258. SegmentAction

Name Description Schema

segments < SegmentPassenger

segment and passenger list
optional > array

3.259. SegmentPassenger

Name Description Schema

arrPort
arrival port of the segment string
optional

depPort
departure port of the segment string
optional

id
id of the segment string
optional

passengers
id list of passengers < string > array
optional

Paxgateway Confidential Page:318/344

Paxgateway

3.260. SendPinViaEmailRequest

Send pin via email service request type

Name Description Schema

email Member email

string
optional Example : "example@crane.com"

memberId Member unique id

string
optional Example : "KJNJK45JBN4"

phoneNumber
PhoneNumber
optional

3.261. SimpleCompany

Company

Name Description Schema

companyFullNa
me Company full name string
optional

contactName
Contact name string
optional

taxNumber
Tax number string
optional

taxOffice
Tax office string
optional

3.262. SimpleSSR

Simple SSR model

Polymorphism : Composition

Paxgateway Confidential Page:319/344

Paxgateway

Name Description Schema

category
string
optional

code SSR code

string
optional Example : "SEAT"

explanation Explanation of Ssr

string
optional Example : "NTBL-NITELIKLI BILET"

free True when SSR is free of charge

boolean
optional Example : false

group SSR Group Code

string
optional Example : "CATERING"

isBundle True when SSR is part of selected bundle

boolean
optional Example : false

price
Price
optional

ssrType SSR type definition.

string
optional Example : ""

3.263. SofortDetail

SofortDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

capturePayme
ntToolNumber Example : true boolean
optional

Paxgateway Confidential Page:320/344

Paxgateway

Name Description Schema

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

threeDomainSe
ThreeDomainSecurit
curity
y
optional

Paxgateway Confidential Page:321/344

Paxgateway

Name Description Schema

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.264. SpecialRequests

A map object for specialRequests. Key field build with segmentId + passengerId. Fields created
dynamically

Name Description Schema

segment_passe
nger SSRs for Passenger and Segment < SSR > array
optional

3.265. SsrModifyRequest

Special service request mofidy (add/change/delete) request

Name Description Schema

explanation Explanation of Ssr

string
optional Example : "NTBL-NITELIKLI BILET"

passengerId
Passenger Id string
required

quantity SSR quantity

integer
optional Example : 10

If ssrCode equals SEAT this value will be used for

seatNumber
modification string
optional
Example : "1A"

Paxgateway Confidential Page:322/344

Paxgateway

Name Description Schema

segmentId
Flight segment id string
required

SSR code for modification. Like WBAG, PBAG, TAVK, SEAT

ssrCode
etc. string
required
Example : "SEAT"

3.266. SsrModifyResponse

SSR Modify Response

Name Description Schema

bookingCreate
Booking created date
Date string (date-time)
Example : "24.09.2018 13:08:36"
optional

bookingId Pnr Booking ID

string
optional Example : "17ABC4"

needPayment
PNR is need payment boolean
optional

pnrReferenceId Pnr Reference ID

string
optional Example : "1245ABCD"

priceDetails
Price Details < PriceDetail > array
optional

priceOverview
PriceOverview
required

specialRequest
s SpecialRequests
required

ticketTimeLimit Ticket Time Limit

string (date-time)
optional Example : "24.09.2018 13:08:36"

Paxgateway Confidential Page:323/344

Paxgateway

Name Description Schema

enum (ONE_WAY,
ROUND_TRIP,
INBOUND_OPEN,
tripType
Trip Type MULTI_DIRECTIONAL
optional
, OUTBOUND_OPEN,
INBOUND_OUTBOU
ND_OPEN)

3.267. StateList

State list information model

Name Description Schema

state
state information list < StateType > array
optional

3.268. StateType

State list model

Polymorphism : Composition

Name Description Schema

cityList
CityList
optional

codeContext
code context string
optional

locationCode
location code string
optional

locationName
location name string
optional

Paxgateway Confidential Page:324/344

Paxgateway

Name Description Schema

locationNameL
anguage language of location name string
optional

3.269. StopLocation

Flight Stop Location Model

Name Description Schema

arrDateTime Arrival date and time

string (date-time)
optional Example : "01.01.2018 13:35"

depDateTime Departure date and time

string (date-time)
optional Example : "01.01.2018 13:35"

groundDuratio
Duration on ground in secons
n integer
Example : 7200
optional

port Stop location port

string
optional Example : "IST"

sequence Sequence of stopping points

integer
optional Example : 1

3.270. SubPackagePrice

SubPackage Price information

Polymorphism : Composition

Name Description Schema

code Price for code. Like tax code

string
optional Example : "1003"

Paxgateway Confidential Page:325/344

Paxgateway

Name Description Schema

currency Currency ISO code

string
required Example : "TRY"

name Name of coded price

string
optional Example : "STANDART_DOMESTIC"

packagePrice
PackagePrice
optional

redeemedMiles
Equivalent miles number
optional

Amount
value
Minimum value : 0 number (money)
required
Example : 125.02

3.271. Subject

Name Schema

categoryId
integer (int64)
optional

description
string
optional

id
integer (int64)
optional

name
string
optional

3.272. ThreeDomainSecurity

ThreeDomainSecurity

Paxgateway Confidential Page:326/344

Paxgateway

Name Schema

clientBaseURL
string
optional

clientCancelPage
string
optional

clientFailPage
string
optional

clientOkPage
string
optional

gatewayURL
string
optional

pareq
string
optional

3.273. Ticket

Conjunctive Ticket Model For Ticketing Service

Name Description Schema

arranger
TicketArranger
optional

associatedCoup
< AssociatedCoupon
ons List of Associated Coupons
> array
optional

bookingId Booking Number

string
optional Example : "ZW49AV"

conjunctiveTick
< ConjunctiveTicket >
ets List of Conjunctive Ticket
array
optional

Paxgateway Confidential Page:327/344

Paxgateway

Name Description Schema

coupons
List of Coupons < Coupon > array
optional

endorsement
Example : "EXAMPLE" string
optional

equivalentFare
Paid Example : "EXAMPLE" string
optional

exchangedPrice
Detail PriceDetail
optional

fareCalculation enum (MANUAL,

Method AUTOMATIC,
optional CENTRAL, PASS)

fareConstructio
n Example : "EXAMPLE" string
optional

inclusiveTour
Example : true boolean
optional

invoiceAmount
Price
optional

issuedBy Example : "RQ KBL IN ISO:AF 18SEP2019

string
optional 10005808 Internet /A"

modificationTy
enum (VOLUNTARY,
pe
INVOLUNTARY)
optional

Paxgateway Confidential Page:328/344

Paxgateway

Name Description Schema

originalIssueDa
te Example : "18.03.2019" string
optional

originalSuggest
edServiceFee Price
optional

originalTicketN
umber Example : "EXAMPLE" string
optional

parentTicketNu
mber Example : "EXAMPLE" string
optional

passenger
TicketPassenger
optional

paymentDetail
< PaymentDetail >
s List of payment details
array
optional

paymentTypesI
nfo Example : "EXAMPLE" string
optional

pnrReferenceId singular numerical value of pnr

string
optional Example : "123456"

presentAt
Example : "EXAMPLE" string
optional

presentTo
Example : "EXAMPLE" string
optional

Paxgateway Confidential Page:329/344

Paxgateway

Name Description Schema

priceDetail
PriceDetail
optional

priceOverview
PriceOverview
optional

reasonForIssua
nce ReasonForIssuance
optional

refundPriceDet
ail PriceDetail
optional

ssr
SSR
optional

suggestedServi
ceFee Price
optional

ticketDocumen
tNbr Example : "123413241324" string
optional

totalAmountTe
xt Example : "150 EUR" string
optional

totalVAT
Price
optional

tourCode
Example : "XYZ" string
optional

Paxgateway Confidential Page:330/344

Paxgateway

Name Description Schema

enum (E_TICKET,
type
PAPER, MCO,
optional
EMD_A, EMD_S)

3.274. TicketArranger

Reservation arranger

Name Description Schema

agencyCode
Agency Code string
optional

agencyName
Agency Name string
optional

agencyType
Agency Type string
optional

companyName
Company name string
optional

contact
TicketContact
optional

contactName
Contact name string
optional

currency
Currency type string
optional

iataNumber
Iata number string
optional

userCode
User code string
optional

Paxgateway Confidential Page:331/344

Paxgateway

Name Description Schema

userName
Username string
optional

3.275. TicketContact

Contact informations

Name Description Schema

address
Address
optional

company
Company
optional

country Country iso Code

string
optional Example : "TR"

email Contact email address

string
optional Example : "asd@asd.com"

givenName Contact first name

string
optional Example : "John"

middleName Contact middle name

string
optional Example : "Smith"

phoneNumber
Contact phone number phoneNumber
optional

shareMarketIn
this contact info can be used for marketing
d boolean
Example : false
optional

this contact info can be used for sending Reservation info

smsRezInfo
sms boolean
optional
Example : true

Paxgateway Confidential Page:332/344

Paxgateway

Name Description Schema

surname Contact surname

string
optional Example : "Doe"

phoneNumber

Name Description Schema

areaCode
Example : "555" string
optional

countryCode
Example : "90" string
optional

number
Example : "1234567" string
optional

3.276. TicketPassenger

Ticket Passenger Informations

Polymorphism : Composition

Name Description Schema

address
Passenger Address List < Address > array
optional

birthDate Passenger birth date

string (date)
optional Example : "28.12.1972"

company
Company
optional

country Passenger origin country

string
optional Example : "TR"

documents
Passenger id document information < Document > array
optional

Paxgateway Confidential Page:333/344

Paxgateway

Name Description Schema

gender
Passenger gender enum (M, F)
optional

givenName Passenger first name

string
optional Example : "John"

givenNameEn
string
optional

hasInfant This field only can be true for ALDT passengers.

boolean
optional Example : false

hasStrecher
boolean
optional

id Unique ID for Passenger

string
optional Example : "1234546"

membershipId Loyalty services id

string
optional Example : "1234545"

middleName Passenger middle name

string
optional Example : "Smith"

parentId If Passenger is infant or child which adult is responsible

integer
optional Example : 12345

parentSequenc
e integer
optional

passengerIIN IIN information should be 12 char(not required)

string
optional Example : "123456789123"

passengerType enum (ADLT, CHLD,

Passenger type
optional INFT)

Paxgateway Confidential Page:334/344

Paxgateway

Name Description Schema

requestedSeat
Count integer
optional

shareMarketIn
d boolean
optional

socialSecurityN
Social Security Number
o string
Example : "1234545"
optional

surname Passenger surname

string
optional Example : "Doe"

surnameEn
string
optional

title Passenger title selected from Title service results.

string
optional Example : "Doctor"

unaccompanie
dMinor boolean
optional

3.277. TicketWithoutPaymentRequest

Confirm purchase request

Name Schema

productNo
string
optional

3.278. TierMile

Tier mile

Paxgateway Confidential Page:335/344

Paxgateway

Name Description Schema

code
Code string
optional

expireDate Expire date

string (date)
optional Example : "11.11.2017"

expireDateOnC
ard Expire date on card string
optional

miles
Miles number
optional

name
Name string
optional

3.279. TravelInsurance

Travel insurance

Name Description Schema

description
Insurance description string
optional

endDate End date

string (date)
optional Example : "11.11.2018"

policyCode
Policy code string
optional

policyNumber
Policy number string
optional

selected
Is selected boolean
optional

Paxgateway Confidential Page:336/344

Paxgateway

Name Description Schema

startDate Start date

string (date)
optional Example : "11.11.2018"

totalAmount
Price
optional

3.280. TriggerTwoFactorAuthRequest

Trigger two factor authentication request

Name Description Schema

action Current action

string
optional Example : "ManageBooking"

id id of current operation
string
optional Example : "VGKJ0Y"

3.281. TriggerTwoFactorAuthResponse

Trigger two factor authentication response

Name Description Schema

code Two factor authentication code

string
optional Example : "3TVR"

3.282. TurkcellCuzdanDetail

TurkcellCuzdanDetail model for GET /ticket service

Polymorphism : Composition

Name Description Schema

avsEnabled
Example : true boolean
optional

Paxgateway Confidential Page:337/344

Paxgateway

Name Description Schema

capturePayme
ntToolNumber Example : true boolean
optional

description
string
optional

inlineFormPay
mentParamete InlineFormPaymentP
r arameter
optional

pares
string
optional

paymentCode
string
optional

paymentRefere
nceID string
optional

paymentSubTy
peCode string
optional

pspInfo
PspInfo
optional

pspTransaction
Reference string
optional

remarks
string
optional

Paxgateway Confidential Page:338/344

Paxgateway

Name Description Schema

threeDomainSe
ThreeDomainSecurit
curity
y
optional

threeDomainSe
curityEligible Example : true boolean
optional

transactionFee
Applies Example : true boolean
optional

3.283. UpdateMemberProfileRequest

Update member profile request

Polymorphism : Composition

Name Description Schema

addressList < MemberAddress >

List of addresses
optional array

birthDate Birth date

string (date)
optional Example : "11.01.1995"

consentAddres
Consent Address
s boolean
Example : true
optional

consentEmail Consent Email

boolean
optional Example : true

consentFax Consent Fax

boolean
optional Example : true

Paxgateway Confidential Page:339/344

Paxgateway

Name Description Schema

consentSms Consent Sms

boolean
optional Example : true

emails < MemberEmail >

List of e-mails
optional array

enrollmentSou
Member enrollment source
rce string
Example : "INTERNET"
optional

gender
Gender string
optional

givenName Firstname
string
optional Example : "JOHN"

knownTraveler
Number Known Traveler Number string
optional

language Language
string
optional Example : "TR"

maritalStatus
Marital status string
optional

marriageDate
Marriage date string (date)
optional

membershipId
Unique id of the member string
optional

middleName Middlename
string
optional Example : "SMITH"

nationalId National ID
string
optional Example : "11111111111"

Paxgateway Confidential Page:340/344

Paxgateway

Name Description Schema

nationality Nationality
string
optional Example : "TR"

passportExpiry
Date Passport expire date string (date)
optional

passportNo
Passport no string
optional

personalInfoLis <
t MemberPersonalInfo
optional > array

<
phoneNumbers
List of phone numbers MemberPhoneNumb
optional
er > array

pin
Member authentication password string
optional

redressNumber
Redress Number string
optional

referringMemb
ershipID Referring member id string
optional

signupDate Member signup date

string
optional Example : "11.03.2019"

status Member status

string
optional Example : "AC"

surname Lastname
string
optional Example : "SNOW"

Paxgateway Confidential Page:341/344

Paxgateway

Name Description Schema

title Title
string
optional Example : "DR"

3.284. UpgradePackagesResponse

UpgradePackagesResponse

Name Schema

flight
Flight
optional

packages
< Package > array
optional

3.285. VersionResponse

Name Description Schema

enum (OK,
status
Status definition SHOULD_UPDATE,
required
MUST_UPDATE)

3.286. Voucher

Voucher (EMD) model

Name Schema

price
Price
optional

voucherId
string
optional

Paxgateway Confidential Page:342/344

Paxgateway

3.287. WarningNotification

Warning notification

Name Description Schema

description
Description string
optional

notificationTim
e Notification time number (date)
optional

targetAgent
Target agent string
optional

3.288. detailedHealthCheck

Status

Name Description Schema

cacheHitRate Service Cache Hit Rate

string
optional Example : "0.9320048254328405"

executionTime service request processing time in nanoseconds

string
optional Example : "81758867"

serviceName Service Name

string
optional Example : "BL"

status Service Status

boolean
optional Example : true

Service URL
url Example : "https://kzr-
string
optional stage.crane.aero/CraneAvailabilityServic
e"

Paxgateway Confidential Page:343/344

Paxgateway

Name Description Schema

version Service Version İnformation

string
optional Example : "4.22"

Paxgateway Confidential Page:344/344