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) andhttps://api.openroam.com(Production). Every path starts with/v1. Code samples use Sandbox. - Authentication: the
X-Partner-Keyheader on every request. See Authentication. - Errors: every error has the body described in Errors.
Shared
| Section | Covers |
|---|---|
| Account | The products enabled for your account |
| Orders | Mixed orders and quotes, reading orders, cancellation previews, email resend |
| Order items | Reading, cancelling, updating and amending what you bought |
| Wallets | Wallet balances, transactions and transfers |
| Currencies | Supported currencies and their rates |
| Reference data | Countries and mobile network codes |
Products
| Section | Guide |
|---|---|
| eSIMs | eSIMs guide |
| Airtime | Airtime guide |
| Utility | Utility guide |
| Gift cards | Gift cards guide |
| Hotels and hotel manual amendments | Hotels guide |
| Flights | Flights guide |
Webhook events
The webhook events section documents the body of every event OpenRoam sends. See Webhooks for signatures and delivery.