Skip to content
FX-Port/Docs
GuidesAPI referenceChangelog
Get API keys
  • Overview
  • Error object

Balances

  • BalancesGET
  • Balance historyGET

Bookings

  • Booking historyGET
  • Get a bookingGET

Suppliers

  • SuppliersGET

Objects

  • Account booking

Account ยท Objects

The Account booking object

A booking of your agency in the account endpoints, whatever its product: flight, hotel, eSIM or transfer.

The top level is a camelCase summary shared with the booking history; record is the stored booking in snake_case; flights and hotels add the price breakdown and the balance operations.

The amount debited from your agency balance is netPrice: totalPrice minus agencyCommission. Use id (a UUID) as your key for a booking: public references are not unique across suppliers.

Attributes

productstring

The product of the booking.

One of flights, hotels, esims, transfers.

idstring (uuid)

Internal id of the booking (UUID). Stable and unique: store it as your key.

bookingIdstringdeprecated

Legacy name, still accepted. Use booking_id instead.

The public reference of the booking: the airline record locator of a flight (not unique across suppliers), the hotel booking id, FX- followed by a number for an eSIM, or the transfer reference. The older name of booking_id: same value, use booking_id.

booking_idstring

The public reference of the booking: the airline record locator of a flight (not unique across suppliers), the hotel booking id, FX- followed by a number for an eSIM, or the transfer reference. The snake_case twin of bookingId, with the same value: use this name.

statusstring

State of the booking. The values depend on the product: for example confirmed, awaiting_payment (a held flight that is not paid), cancelled, failed, refunded, partial_refund.

environmentstring

The environment of the key that made the call: sandbox for fxp_test_ keys, live for fxp_live_ keys. Present in every JSON body.

One of sandbox, live.

agencyIdstring (uuid)deprecated

Legacy name, still accepted. Use agency_id instead.

The id of your agency. The older name of agency_id: same value, use agency_id.

agency_idstring (uuid)

The id of your agency. The snake_case twin of agencyId, with the same value: use this name.

agentIdstringnullabledeprecated

Legacy name, still accepted. Use agent_id instead.

The user of your agency who created the booking, or null when it was created through an API key without a user. The older name of agent_id: same value, use agent_id.

agent_idstringnullable

The user of your agency who created the booking, or null when it was created through an API key without a user. The snake_case twin of agentId, with the same value: use this name.

currencystring

Currency of the amounts: the settlement currency of your agency.

totalPricenumberdeprecated

Legacy name, still accepted. Use total_price instead.

What the traveler pays, in your agency currency. It includes your commission. The older name of total_price: same value, use total_price.

total_pricenumber

What the traveler pays, in your agency currency. It includes your commission. The snake_case twin of totalPrice, with the same value: use this name.

netPricenumberdeprecated

Legacy name, still accepted. Use b2b_price instead.

The amount debited from your agency balance: totalPrice minus agencyCommission. The older name of b2b_price: same value, use b2b_price.

b2b_pricenumber

The amount debited from your agency balance: totalPrice minus agencyCommission. The snake_case twin of netPrice, with the same value: use this name.

agencyCommissionnumberdeprecated

Legacy name, still accepted. Use agency_commission instead.

Your commission as an amount, in your agency currency. 0 when there is none. The older name of agency_commission: same value, use agency_commission.

agency_commissionnumber

Your commission as an amount, in your agency currency. 0 when there is none. The snake_case twin of agencyCommission, with the same value: use this name.

providerNamestringnullabledeprecated

Legacy name, still accepted. Use provider_name instead.

Name of the supplier that fulfilled the booking. The older name of provider_name: same value, use provider_name.

provider_namestringnullable

Name of the supplier that fulfilled the booking. The snake_case twin of providerName, with the same value: use this name.

supplierIdstringnullabledeprecated

Legacy name, still accepted. Use supplier_id instead.

Id of the supplier that fulfilled the booking, as stored on the booking. It can differ from the id the supplier list uses: ratehawk and airalo here are worldota_1 and airalo_1 there. The older name of supplier_id: same value, use supplier_id.

supplier_idstringnullable

Id of the supplier that fulfilled the booking, as stored on the booking. It can differ from the id the supplier list uses: ratehawk and airalo here are worldota_1 and airalo_1 there. The snake_case twin of supplierId, with the same value: use this name.

createdAtstringdeprecated

Legacy name, still accepted. Use created_at instead.

When the booking was created: ISO 8601, UTC. The older name of created_at: same value, use created_at.

created_atstring

When the booking was created: ISO 8601, UTC. The snake_case twin of createdAt, with the same value: use this name.

updatedAtstringdeprecated

Legacy name, still accepted. Use updated_at instead.

When the booking last changed: ISO 8601, UTC. The older name of updated_at: same value, use updated_at.

updated_atstring

When the booking last changed: ISO 8601, UTC. The snake_case twin of updatedAt, with the same value: use this name.

departureAirportstring

Flights only. IATA code of the first departure airport.

arrivalAirportstring

Flights only. IATA code of the final arrival airport.

departureDatestring

Flights only. Local departure date and time of the first segment, without a zone.

arrivalDatestring

Flights and transfers. Local arrival date and time, without a zone for flights.

ticketNumberstringnullable

Flights only. The ticket number once issued, or null.

requireAcdbooleannullabledeprecated

Legacy name, still accepted. Use require_acd instead.

Flights only. Whether the booking needs ACD documents. The older name of require_acd: same value, use require_acd.

require_acdbooleannullable

Flights only. Whether the booking needs ACD documents. The snake_case twin of requireAcd, with the same value: use this name.

voucherUrlstringnullable

Flights and hotels: the confirmation PDF with prices (same as voucherUrlWithPrice), null while it is generated. Transfers: the supplier voucher, null until a driver is assigned.

voucherUrlWithPricestringnullable

Flights and hotels. The confirmation PDF with prices.

voucherUrlNoPricestringnullable

Flights and hotels. The confirmation PDF without prices, to give to the traveler.

hotelIdstring

Hotels only. The id of the hotel.

hotelNamestringnullable

Hotels only. The name of the hotel, or null when the supplier did not give one (a failed booking, for example).

checkinDatestring

Hotels only. Check-in date: YYYY-MM-DD.

checkoutDatestring

Hotels only. Check-out date: YYYY-MM-DD.

bookingModestringnullable

Hotels only. How the booking was made, for example standard.

orderIdstringdeprecated

Legacy name, still accepted. Use order_id instead.

eSIMs only. The supplier's order code. The older name of order_id: same value, use order_id.

order_idstring

eSIMs only. The supplier's order code. The snake_case twin of orderId, with the same value: use this name.

typestring

eSIMs only. esim for an order, topup for a topup.

One of esim, topup.

packageNamestringdeprecated

Legacy name, still accepted. Use package_name instead.

eSIMs only. Name of the package. The older name of package_name: same value, use package_name.

package_namestring

eSIMs only. Name of the package. The snake_case twin of packageName, with the same value: use this name.

iccidstring

eSIMs only. The ICCID of the eSIM.

customerEmailstringdeprecated

Legacy name, still accepted. Use customer_email instead.

eSIMs only. The traveler's email. The older name of customer_email: same value, use customer_email.

customer_emailstring

eSIMs only. The traveler's email. The snake_case twin of customerEmail, with the same value: use this name.

customer_first_namestring

eSIMs only. The traveler's first name.

customer_last_namestring

eSIMs only. The traveler's last name.

customer_phonestring

eSIMs only. The traveler's phone number.

flightNumberstringnullable

Transfers only. The flight number the transfer was booked for.

receiptUrlstringnullable

Transfers only. FX-Port's receipt PDF, once the booking is confirmed.

recordobject

The stored record of the booking, in snake_case. The keys that exist depend on the product; a key that does not apply is absent.

ShowHide 45 attributes
idstring (uuid)

Internal id of the booking (UUID).

booking_idstring

The public reference of the booking.

order_idstring

eSIMs only. The supplier's order code.

statusstring

State of the booking.

currencystring

Currency of the amounts.

total_pricenumber

What the traveler pays, in your agency currency.

agency_commissionnumber

Your commission as an amount.

departure_airportstring

Flights only. IATA code of the first departure airport.

arrival_airportstring

Flights only. IATA code of the final arrival airport.

departure_datestring

Flights only. Local departure date and time of the first segment.

arrival_datestring

Flights and transfers. Local arrival date and time.

return_departure_datestringnullable

Flights only. Departure of the return trip, or null.

return_arrival_datestringnullable

Flights only. Arrival of the return trip, or null.

included_checked_bagsstringnullable

Flights only. Checked bags included in the fare.

ticket_numberstringnullable

Flights only. The ticket number once issued, or null.

require_acdbooleannullable

Flights only. Whether the booking needs ACD documents.

hotel_idstring

Hotels only. The id of the hotel.

hotel_namestring

Hotels only. The name of the hotel.

checkin_datestring

Hotels only. Check-in date: YYYY-MM-DD.

checkout_datestring

Hotels only. Check-out date: YYYY-MM-DD.

booking_modestringnullable

Hotels only. How the booking was made.

free_cancellation_deadline_atstringnullable

Hotels only. Until when the booking can be cancelled free of charge, or null.

typestring

eSIMs only. esim or topup.

One of esim, topup.

package_namestring

eSIMs only. Name of the package.

iccidstring

eSIMs only. The ICCID of the eSIM.

customer_emailstring

eSIMs only. The traveler's email.

customer_first_namestring

eSIMs only. The traveler's first name.

customer_last_namestring

eSIMs only. The traveler's last name.

customer_phonestring

eSIMs only. The traveler's phone number.

provider_namestring

eSIMs and transfers. Name of the supplier.

supplier_idstring

Hotels and eSIMs. Id of the supplier, as stored on the booking.

flight_numberstringnullable

Transfers only. The flight number.

bucket_linkstringnullable

Flights, hotels and transfers. The confirmation PDF with prices; for a transfer, FX-Port's receipt.

bucket_link_no_pricestringnullable

Flights and hotels. The confirmation PDF without prices.

voucher_linkstringnullable

Transfers only. The supplier voucher, once a driver is assigned.

refund_amountnumbernullable

Flights and hotels. The amount refunded, or null.

refund_currencystringnullable

Flights and hotels. The currency of the refund, or null.

refund_methodstringnullable

Flights only. How the refund was made, or null.

refunded_amountnumbernullable

Transfers only. The amount refunded, or null.

refunded_currencystringnullable

Transfers only. The currency of the refund, or null.

paid_atstringnullable

Flights and hotels. When the booking was paid, or null.

voided_atstringnullable

Flights only. When the ticket was voided, or null.

created_atstring

When the booking was created: ISO 8601, UTC.

updated_atstring

When the booking last changed: ISO 8601, UTC.

environmentstring

The environment of the key that made the call: sandbox for fxp_test_ keys, live for fxp_live_ keys. Present in every JSON body.

One of sandbox, live.

pricingarray of object

Flights and hotels only. The price breakdown.

ShowHide 11 attributes
idstring (uuid)

Hotels only. Id of the pricing row.

supplier_currencystring

Flights only. The currency the supplier prices in.

agency_currencystring

The currency of your agency.

base_pricenumber

Flights only. The fare before taxes.

taxes_and_feesnumber

Flights only. Taxes and fees, without your commission.

total_pricenumber

Hotels only. What the traveler pays.

agency_commissionnumber

Your commission as an amount.

final_pricenumber

Flights only. What the traveler pays: base_price plus taxes_and_fees plus agency_commission.

b2b_pricenumber

The amount debited from your agency balance: the total minus agency_commission.

created_atstring

When the row was written: ISO 8601, UTC.

environmentstring

The environment of the key that made the call: sandbox for fxp_test_ keys, live for fxp_live_ keys. Present in every JSON body.

One of sandbox, live.

travelerPricingarray of objectdeprecated

Legacy name, still accepted. Use traveler_pricing instead.

Flights only. The price per traveler. The older name of traveler_pricing: same value, use traveler_pricing.

ShowHide 10 attributes
traveler_idstring

The traveler the row is for: the id of the traveler in the booking.

traveler_typestring

ADULT, CHILD, INFANT and so on.

fare_optionstring

The fare option, for example STANDARD.

supplier_currencystring

The currency the supplier prices in.

agency_currencystring

The currency of your agency.

basenumber

The fare of this traveler before taxes.

totalnumber

What this traveler's ticket costs the traveler.

b2b_pricenumber

The amount debited from your agency balance for this traveler.

created_atstring

When the row was written: ISO 8601, UTC.

environmentstring

The environment of the key that made the call: sandbox for fxp_test_ keys, live for fxp_live_ keys. Present in every JSON body.

One of sandbox, live.

traveler_pricingarray of object

Flights only. The price per traveler. The snake_case twin of travelerPricing, with the same value: use this name.

ShowHide 10 attributes
traveler_idstring

The traveler the row is for: the id of the traveler in the booking.

traveler_typestring

ADULT, CHILD, INFANT and so on.

fare_optionstring

The fare option, for example STANDARD.

supplier_currencystring

The currency the supplier prices in.

agency_currencystring

The currency of your agency.

basenumber

The fare of this traveler before taxes.

totalnumber

What this traveler's ticket costs the traveler.

b2b_pricenumber

The amount debited from your agency balance for this traveler.

created_atstring

When the row was written: ISO 8601, UTC.

environmentstring

The environment of the key that made the call: sandbox for fxp_test_ keys, live for fxp_live_ keys. Present in every JSON body.

One of sandbox, live.

balanceOperationsarray of objectdeprecated

Legacy name, still accepted. Use balance_operations instead.

Flights and hotels only. The balance operations of the booking: empty in the sandbox. The older name of balance_operations: same value, use balance_operations.

ShowHide 7 attributes
idstring (uuid)

Id of the operation.

typestring

debit, credit or refund, in lower case.

amountnumber

The amount, always positive.

currencystring

The currency of the operation.

descriptionstringnullable

A label of the operation.

createdAtstringdeprecated

Legacy name, still accepted. Use created_at instead.

When the operation was recorded: ISO 8601, UTC. The older name of created_at: same value, use created_at.

created_atstring

When the operation was recorded: ISO 8601, UTC. The snake_case twin of createdAt, with the same value: use this name.

balance_operationsarray of object

Flights and hotels only. The balance operations of the booking: empty in the sandbox. The snake_case twin of balanceOperations, with the same value: use this name.

ShowHide 7 attributes
idstring (uuid)

Id of the operation.

typestring

debit, credit or refund, in lower case.

amountnumber

The amount, always positive.

currencystring

The currency of the operation.

descriptionstringnullable

A label of the operation.

createdAtstringdeprecated

Legacy name, still accepted. Use created_at instead.

When the operation was recorded: ISO 8601, UTC. The older name of created_at: same value, use created_at.

created_atstring

When the operation was recorded: ISO 8601, UTC. The snake_case twin of createdAt, with the same value: use this name.

PreviousThe eSIM booking object

ยฉ 2026 FX-Port

TermsPrivacy[email protected]