Skip to Content
OpenRoam Docs
Airtime

Get an airtime operator

Returns one operator with its offers for a phone number of its country (manual flow, step 2).

GET
/v1/airtime/operators/{id}

Returns one operator with its offers for a phone number of its country (manual flow, step 2).

Returns the operator in the item shape that search returns, without a carrier lookup. A number of another country than the operator's gives 400 / 10001 with COUNTRY_MISMATCH at phoneNumber. An unknown ID, including any value that is not an operator ID, or an operator without an orderable offer, gives 404 / 10004. Offer filters that match none of the operator's offers leave offers empty. A manual choice is not checked against the number's carrier, so have the customer confirm the operator before ordering.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

The operator ID (operator_…) from the operator list, the catalog or search.

Query Parameters

phoneNumber*string

The recipient's number in international format, starting with + or 00. It must belong to the operator's country.

valueType?string

Keep only fixed or only range offers.

Value in"fixed""range"
valueCurrency?string

Currency of minValue and maxValue, three letters; required with either of them.

minValue?number

Keep the offers whose value reaches at least this amount, in valueCurrency.

Formatdecimal
maxValue?number

Keep the offers whose value starts at or below this amount, in valueCurrency.

Formatdecimal
minPrice?number

Keep the offers whose indicative price reaches at least this amount, in the price currency.

Formatdecimal
maxPrice?number

Keep the offers whose indicative price starts at or below this amount, in the price currency. A filter, not the inputs.maxPrice limit of a purchase.

Formatdecimal
currency?string

Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at currency, reason NOT_SUPPORTED.

Response Body

OK

  1. response

One operator with its offers, as search and operators/{id} return it. id is the stable operator id operator_…, which is never orderable; an order names one of its offers by public ID. Airtime has no categories or operator descriptions, so category and description are always null. Prices are indicative; quote recalculates them.

id*string
name*string
countryCode*string
category?string|null
logoUrl?string|null
description?string|null
offers*array<>
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/airtime/operators/operator_tq7vbm2xk4hdn6wzr3pyjc5fae?phoneNumber=%2B994501234567&valueType=range&valueCurrency=AZN&minValue=10&maxValue=200&minPrice=5&maxPrice=130&currency=USD'
Example Response
{  "id": "string",  "name": "string",  "countryCode": "string",  "category": "string",  "logoUrl": "string",  "description": "string",  "offers": [    {      "publicId": "string",      "name": "string",      "description": "string",      "value": {        "amount": 0,        "currency": "string",        "type": "fixed"      },      "price": {        "amount": 0,        "currency": "string"      },      "requiredInputs": [        {          "name": "string",          "type": "text",          "required": true,          "description": "string",          "fields": [            {}          ]        }      ],      "details": {        "redemptionType": "directTopUp",        "readMore": "string"      }    }  ]}