Skip to Content
OpenRoam Docs

Introduction

One API to sell eSIMs, airtime, bill payments, gift cards, hotels and flights.

The OpenRoam Partner API lets you sell travel and digital products to your own customers through one integration. Every product follows the same three steps, uses the same order, the same errors and the same webhooks, so once you have integrated one product the others work the same way.

ProductWhat your customer gets
eSIMsA data plan for a country, a region or the world, installed on their phone
AirtimeMobile credit sent straight to a phone number
UtilityA paid bill, such as prepaid electricity
Gift cardsA digital gift card code, optionally emailed as a gift
HotelsA confirmed hotel booking
FlightsA ticketed flight booking

How it works

Find what to sell. A search returns items (an operator, a biller, a gift card brand, an eSIM destination, a hotel or a flight itinerary), and each item lists the offers you can buy. An offer's publicId is the only id you order with.

Quote

Send the offer with the customer's inputs to the product's quote route. The quote validates everything the order would, and returns the current price without buying anything.

Order

Send the quoted body to the product's order route (or to POST /v1/orders to mix products in one order) with an Idempotency-Key, each item's publicId set to the one the quote returned: for hotels, flights and gift cards it can differ from the one you searched with. OpenRoam charges your wallet and delivers the product. You follow delivery with the order read or with the order.fulfillment.updated webhook.

Conventions

  • Base URL and paths. Every route starts with /v1, for example https://api.sandbox.openroam.com/v1/esims/search. See Environments.
  • Authentication. Send your API key in the X-Partner-Key header. See Authentication.
  • Money. Amounts are { "amount": 10.5, "currency": "USD" }. OpenRoam charges you a price; airtime, utility and gift cards also state the value your customer receives.
  • Times. Every time is a UTC instant in ISO 8601 ending in Z, such as 2026-11-16T10:00:00Z. A time bound to a place, such as a flight departure, also comes with the place's time zone and its local clock. A calendar date, such as a check-in date, is a plain date (2026-11-16).
  • Names. JSON members and enum values are camelCase, in responses and in webhooks.
  • Ids. Product and offer ids are opaque strings with a prefix, such as esim_… or rate_…. Orders and order items have UUIDs.
  • Errors. Every error has the same body: code, name, message, requestId and optional details. See Errors.

Where to next

  • Make your first purchase in Sandbox with the Quickstart.
  • Browse every operation in the API reference.
  • Use an official client library from SDKs, or connect an AI agent with the MCP server.

For AI agents

This site is also available as Markdown: /llms.txt lists every page, /llms-full.txt holds all of them, and each page has a Markdown copy at its URL plus .md. The OpenAPI specification is at /openapi.json.

On this page