# FX-Port API

- [Introduction](/): FX-Port is a unified travel API for flights, hotels, eSIMs and more — one integration, many suppliers, best available prices.

- **Getting Started**
- [Authentication](/authentication): How to authenticate with the FX-Port API using Bearer tokens. Key permissions, prefixes, and security guidance.
- [Environments](/environments): Live vs sandbox environments. One base URL, environment determined by API key prefix.
- [Sandbox notice](/sandbox): How sandbox works, supplier sandbox limitations, and what to expect during testing.

- **Suppliers & Account**
- Suppliers
  - [GET /api/v1/suppliers](/suppliers): Discover every enabled supplier across all products — GDS, NDC, LCC and direct airlines — with capabilities and void deadlines.
- Account
  - [Account API overview](/account): Agency balances, financial ledger, and cross-product booking history.
  - [GET /api/v1/balances](/account/balances): Current balance for each currency the agency holds.
  - [GET /api/v1/balances/{balance_id}/history](/account/balance-history): Complete financial ledger for a specific currency balance — top-ups, booking debits, and refunds.
  - [GET /api/v1/history](/account/history): Booking summaries across all products, sorted newest first.
  - [GET /api/v1/bookings/{id}](/account/booking-detail): Single booking detail by public reference — includes pricing breakdown and traveler pricing.

- **Products**
- Flights
  - [Flights API overview](/flights): FX-Port Flights API — search, price, book, hold, pay, and manage flight orders across every enabled GDS, airline, and NDC supplier.

  - **Flight Concepts**
  - [Flight booking flows](/flights/booking-flows): Step-by-step flight booking flows — instant issue, hold-then-pay, and how cancellation of a held PNR works.
  - [Flight passengers & ages](/flights/passengers): Flight passenger types, age rules evaluated at departure, seated vs lap infants, required age arrays, and capacity limits.
  - [Flight pricing](/flights/pricing): What each flight price field means, the b2bPrice formula, and how the exchange rate is presented.
  - [Post-booking operations](/flights/post-booking): Void, exchange, re-issue, and refund of issued flight tickets — how to request them from the FX-Port team today.

  - **Search & Pricing**
  - Flight Search
    - [POST /api/v1/get_flights](/flights/search): Search for flights across one, several, or every enabled supplier. Start here, then expand the examples by route, passenger, filter, supplier, or itinerary type.
    - [Basic route examples](/flights/search/basic-routes): One-way, round-trip, direct-only, and all-supplier flight searches.
    - [Passenger and cabin examples](/flights/search/passenger-and-cabin): Family groups, lap/seated infants, adult-senior-young mixes, and cabin-class searches.
    - [Filter examples](/flights/search/filters): Direct flights, refundable fares, checked bags, price caps, market hints, airline include/exclude/preference, and flexible dates.
    - [Supplier selection](/flights/search/suppliers): Let FX-Port select suppliers automatically, or pass exact supplier IDs for a special case.
    - [Open-jaw searches](/flights/search/complex-itineraries): Search two non-reversed flight segments with the segments array.
  - [POST /api/v1/flights/flexible_search](/flights/flexible-search): Returns a ±3-day price matrix from suppliers that support flexible-date searches.
  - [POST /api/v1/flights/price_flight](/flights/price): Price a cached flight offer to confirm the current fare. Required before booking — book_flight reads the priced offer from this cache.

  - **Booking**
  - [POST /api/v1/flights/book_flight](/flights/book): Create a booking — instant issue or hold reservation. Requires Read+Write permission.

  - **Hold, Pay & Cancel**
  - [POST /api/v1/flights/get_order_quote](/flights/get-order-quote): Get the current price and payment status for a held order before paying.
  - [POST /api/v1/flights/pay_order](/flights/pay-order): Pay a held order, issue tickets, and debit the agency balance. Requires Read+Write permission.
  - [POST /api/v1/flights/cancel_order](/flights/cancel-order): Cancel a held (unpaid) flight reservation to release the PNR. This is not a refund.

  - **After Booking**
  - [POST /api/v1/flights/get_booking](/flights/get-booking): Retrieve full booking details through one booking_id field that accepts an internal UUID, supplier order ID, or PNR. Includes the PDF download link.
  - [POST /api/v1/flights/get_ticket](/flights/get-ticket): Returns the ticket PDF download URL. Polls ticket_ready until the PDF is ready.

  - **Utilities**
  - [GET /api/v1/flights/airports](/flights/airports): Airport autocomplete for origin/destination inputs. No authentication required. Supports 30+ language locales.
- Hotels
  - [Hotels API](/hotels): FX-Port Hotels API — hotel search, availability, pricing, and booking across global hotel suppliers. Documentation coming soon.
- eSIMs
  - [eSIMs API](/esims): FX-Port eSIMs API — browse data packages, place orders, and top up eSIMs across 190+ countries. Documentation coming soon.