eSIMs
eSIM bookings
List and look up eSIM/topup bookings for your agency.
List bookings
GET /api/v1/esims/bookings
Permission: Read
Paginated list of the agency's own eSIM and topup bookings, searchable by name, email, ICCID, or booking ID.
curl --request GET \
--url 'https://api.fx-port.com/api/v1/esims/bookings?page=1&limit=50&search=' \
--header 'Authorization: Bearer fxp_test_YOUR_KEY'| Query parameter | Description |
|---|---|
search | Match against booking ID, customer name/email, package name, or ICCID |
page / limit | Pagination (limit max 200) |
Response example
{
"success": true,
"data": [
{
"booking_id": "FX-1787835379756",
"order_id": "20260827-088478",
"status": "confirmed",
"currency": "EUR",
"total_price": 9.52,
"agency_commission": 1.02,
"type": "esim",
"package_name": "1 GB - 7 days • France",
"iccid": "8900000338153738419",
"customer_email": "[email protected]",
"customer_first_name": "Ana",
"customer_last_name": "Kova",
"customer_phone": "+34600123456",
"provider_name": "Airalo",
"supplier_id": "airalo",
"created_at": "2026-08-27T12:56:19.000Z"
}
],
"pagination": { "total": 1, "page": 1, "limit": 50, "pages": 1 }
}Only agency-facing fields are returned — supplier source cost, FX-Port's internal platform margin,
and any kiosk/partner-level commission are never included. provider_name / supplier_id identify
which supplier actually fulfilled this specific booking.
Topup history for an ICCID
GET /api/v1/esims/bookings/{iccid}/topup-history
Permission: Read
curl --request GET \
--url https://api.fx-port.com/api/v1/esims/bookings/8900000338153738419/topup-history \
--header 'Authorization: Bearer fxp_test_YOUR_KEY'Returns the same booking shape as list bookings, filtered to type: "topup" rows
for this ICCID.