Skip to Content
OpenRoam Docs

API reference

Every Partner API operation and webhook event, generated from the OpenAPI specification.

This reference is generated from the Partner API OpenAPI specification. Each page shows an operation's parameters, request body, responses and code samples.

  • Base URLs: https://api.sandbox.openroam.com (Sandbox) and https://api.openroam.com (Production). Every path starts with /v1. Code samples use Sandbox.
  • Authentication: the X-Partner-Key header on every request. See Authentication.
  • Errors: every error has the body described in Errors.

Shared

SectionCovers
AccountThe products enabled for your account
OrdersMixed orders and quotes, reading orders, cancellation previews, email resend
Order itemsReading, cancelling, updating and amending what you bought
WalletsWallet balances, transactions and transfers
CurrenciesSupported currencies and their rates
Reference dataCountries and mobile network codes

Products

Webhook events

The webhook events section documents the body of every event OpenRoam sends. See Webhooks for signatures and delivery.

On this page