Skip to Content
OpenRoam Docs
Utility

Utility catalog

Returns every biller with its offers, page by page, for partner inventory.

GET
/v1/utility/catalog

Returns every biller with its offers, page by page, for partner inventory.

Returns { items, nextCursor }, ordered by biller ID, with the search filters except q. Continue with nextCursor as cursor, the same filters and the same currency until it is null; a page can hold fewer billers than limit, even none, while nextCursor is not null. A cursor reused with other filters or another currency gives 400 / 10001. The walk is not a frozen snapshot: update your copy by biller id, and remove a biller only when a complete walk did not return it. On 429, wait for Retry-After and request the same page again.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

countryCode?string

Optional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank value is rejected.

category?string

Keep the billers of this category, for example electricity.

Value in"other""electricity""water""television""internet""gas""toll""voip""landline"
serviceType?string

Keep prepaid or postpaid billers.

Value in"prepaid""postpaid"
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.

cursor?string

The nextCursor of the previous page; omit it for the first page. Reuse it only with the same filters and currency.

limit?integer

Page size, 1 to 100; default 100.

Formatint32

Response Body

OK

  1. response

A page of the partner catalog walk, ordered by biller ID. Continue with nextCursor, the same filters and the same currency until it is null; a page may hold fewer items than the limit, even none.

items*array<>
nextCursor?string|null
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/utility/catalog?countryCode=AZ&category=other&serviceType=prepaid&currency=USD&limit=10'
Example Response
{  "items": [    {      "id": "string",      "name": "string",      "countryCode": "string",      "category": "other",      "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": {        "serviceType": "prepaid",        "deliveryType": "unknown"      }    }  ],  "nextCursor": "string"}