Utility catalog
Returns every biller with its offers, page by page, for partner inventory.
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.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
countryCode?stringOptional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank value is rejected.
category?stringKeep the billers of this category, for example electricity.
"other""electricity""water""television""internet""gas""toll""voip""landline"serviceType?stringKeep prepaid or postpaid billers.
"prepaid""postpaid"currency?stringPrice 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?stringThe nextCursor of the previous page; omit it for the first page. Reuse it only with the same filters and currency.
limit?integerPage size, 1 to 100; default 100.
int32OK
- 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|nullcurl -X GET 'https://api.sandbox.openroam.com/v1/utility/catalog?countryCode=AZ&category=other&serviceType=prepaid¤cy=USD&limit=10'{ "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"}Get a biller GET
Returns one biller with its offers, in the item shape that search returns. An unknown ID, an ID that does not start with `biller_` (an offer's `publicId` among them), or a biller without an orderable offer gives 404 / 10004.
Quote utility payments POST
Prices the order body with current prices, without placing an order. Takes the same body as order, with offer public IDs; a biller's own ID is not an offer (400 / 11004). Each item is priced on its own, in request order; the first failing item aborts the quote and is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. A quote reserves nothing, does not expire, submits no payment and does not check the customer's account with the biller.