FX-Port API
Account

Account API overview

Agency balances, financial ledger, and cross-product booking history.

Read-only endpoints for querying account state: balances, financial transaction history, and booking summaries.

Permission: Read (all endpoints in this section)

These endpoints expose account-level data for reconciliation, dashboards, and integration monitoring. They are not the booking operations API. For full traveler details, fare rules, and booking actions, use the product-specific endpoints (e.g. /api/v1/flights/get_booking).

Endpoints

MethodPathDescription
GET/api/v1/balancesCurrent balance for each currency the agency holds
GET/api/v1/balances/{balance_id}/historyFull financial ledger for a specific currency
GET/api/v1/historyBooking summaries across all products
GET/api/v1/bookings/{id}Single booking detail by public reference

Sandbox behaviour

In sandbox:

  • GET /api/v1/balances returns an empty data array
  • GET /api/v1/balances/{id}/history returns an empty data array
  • GET /api/v1/history returns sandbox bookings only
  • GET /api/v1/bookings/{id} returns sandbox bookings only

Sandbox bookings do not affect the live ledger.

Error responses

HTTPdetail.errorCause
400invalid_datefrom or to is not a valid ISO-8601 value
400invalid_productproduct is not one of the allowed values
401Missing or invalid API key
403Key lacks permission
404booking_not_foundNo booking matches in this environment
500Internal server error

On this page