--- name: api.reloadpi.com description: api.reloadpi.com provides catalog browsing and order status APIs for three digital product categories: mobile top-ups, eSIM plans, and vouchers/gift cards. It exposes read-only catalog endpoints for discovering available offers and country eligibility, plus a single order-status endpoint for eSIM purchases. No order placement, payment, or activation endpoints are included in the available skill set. host: api.reloadpi.com --- # api.reloadpi.com ReloadPi is a digital goods distribution API serving agents that need to browse and present mobile top-up, eSIM, and voucher/gift card catalogs to end users. It covers country eligibility checks, offer discovery with pricing and metadata, and post-purchase eSIM order tracking. The host is catalog- and status-oriented; it does not expose purchase, payment, redemption, or real-time network availability endpoints. ## When to use this host Use api.reloadpi.com when an agent needs to enumerate supported countries, browse offer catalogs with pricing, or check eSIM order fulfillment status for top-ups, eSIMs, or vouchers/gift cards. Do not use this host to place orders, process payments, redeem vouchers, activate eSIMs, validate phone numbers, or check real-time network or operator availability — none of those capabilities are exposed. For order placement, a separate purchase or checkout API would be required. For real-time operator or balance lookups, a carrier-direct or aggregator API with live query support should be used instead. The eSIM order status skill (fetch-esim-order-info) is specific to eSIM catalog orders and cannot be used to track top-up or voucher orders. ## Capabilities ### Country Eligibility Determines which countries are supported for each product type before initiating any catalog lookup or purchase flow. Should be called first to validate user-supplied country codes. - **`fetch-topup-supported-countries`** — Returns the full list of ISO 3166-1 alpha-2 country codes supported by the ReloadPi top-up catalog. - **`fetch-voucher-supported-countries`** — Returns the list of ISO 3166-1 alpha-2 country codes for which vouchers are available in the ReloadPi catalog. ### Voucher Catalog Discovery Enables browsing and filtering of the voucher and gift card catalog, from discovering valid filter dimensions to retrieving paginated offer listings with pricing and brand metadata. - **`fetch-voucher-catalog-filters`** — Returns available filter options for the voucher catalog, including supported countries, sub-types, regions, and brand names. - **`fetch-voucher-offers-catalog`** — Returns a paginated list of voucher and gift card offers including offer IDs, brand names, country/region availability, sub-categories, pricing in USD, and product type. ### Top-Up Offer Catalog Returns the full paginated catalog of mobile top-up and bundle offers for a given country or carrier, including data/voice/SMS allowances and USD pricing. - **`fetch-topup-offers-catalog`** — Returns a paginated catalog of mobile top-up and bundle offers filtered by country and carrier, including pricing in USD, data/voice/SMS allowances, duration, and regional metadata. ### eSIM Catalog and Order Tracking Covers the full eSIM lifecycle available on this host: browsing available eSIM plans by country, region, data, and duration, then checking fulfillment status and retrieving delivery artifacts (ICCID, QR code) for a placed order. - **`fetch-esim-offers-catalog`** — Returns the full catalog of available eSIM plans including country, region, data allowance, duration, pricing, and speed tier subtype for each offer. - **`fetch-esim-order-info`** — Returns fulfillment state, delivery payload (ICCID and QR code URL), refund eligibility, and polling semantics for a catalog eSIM order by orderId. ## Workflows ### Voucher Product Discovery *Use when an agent needs to present a filtered voucher or gift card catalog to a user, starting from unknown filter state.* 1. **`fetch-voucher-supported-countries`** — Validate that the user's target country is eligible for voucher purchase before proceeding. 2. **`fetch-voucher-catalog-filters`** — Retrieve available filter dimensions (sub-types, regions, brands) to narrow the catalog query or populate UI filter options. 3. **`fetch-voucher-offers-catalog`** — Fetch the paginated voucher and gift card listings, using the validated country and filter values to present relevant offers with pricing and brand metadata. ### Top-Up Offer Lookup *Use when an agent needs to present available mobile top-up or bundle offers for a user-specified country.* 1. **`fetch-topup-supported-countries`** — Confirm the user's country is supported in the top-up catalog before fetching offers. 2. **`fetch-topup-offers-catalog`** — Retrieve paginated top-up and bundle offers filtered to the validated country, including pricing and allowance details. ### eSIM Plan Selection and Order Tracking *Use when an agent needs to help a user select an eSIM plan and then monitor fulfillment of a subsequently placed order.* 1. **`fetch-esim-offers-catalog`** — Browse available eSIM plans by country, region, data size, duration, and speed tier to identify the offer ID for purchase. 2. **`fetch-esim-order-info`** — After an order has been placed externally, poll this skill with the orderId to retrieve fulfillment status, ICCID, QR code URL, and refund eligibility. ## Skill reference ### `fetch-esim-order-info` **eSIM Order Info** — Returns fulfillment state, delivery payload (ICCID and QR code URL), refund eligibility, and polling semantics for a catalog eSIM order by orderId. *Use when:* Use when an agent needs to check the current fulfillment status of a previously placed eSIM order, retrieve the ICCID or QR code for delivery, or determine refund eligibility after a purchase. *Not for:* Do not use to place a new eSIM order or to look up top-up/voucher orders; refund eligibility and policies differ by product type and this endpoint is specific to eSIM catalog orders. **Inputs:** - `orderId` (string, required) — UUID of the eSIM order returned from a prior purchase call. Used to poll fulfillment state and retrieve delivery payload. **Returns:** Returns an order object with status (e.g. FULFILLED), delivery payload containing ICCID and QR code URL, refund eligibility flag, refund policy, and poll_again flag indicating whether further polling is needed. **Example:** `GET https://api.reloadpi.com/api/catalog/esims/orders/info?orderId=550e8400-e29b-41d4-a716-446655440000` --- ### `fetch-voucher-catalog-filters` **Voucher Filter Catalog** — Returns available filter options for the voucher catalog, including supported countries, sub-types, regions, and brand names. *Use when:* Use when an agent needs to discover valid filter values (countries, regions, sub-types, or brands) before querying or displaying the voucher catalog to a user. *Not for:* Do not use to retrieve actual voucher listings or pricing; use a voucher search or catalog endpoint instead. **Returns:** Returns a JSON object with four arrays: countries (ISO codes), subTypes (category labels), regions (geographic groupings), and brands (brand name strings). **Example:** `GET https://api.reloadpi.com/api/catalog/vouchers/filters` --- ### `fetch-voucher-supported-countries` **ReloadPi Voucher Countries** — Returns the list of ISO 3166-1 alpha-2 country codes for which vouchers are available in the ReloadPi catalog. *Use when:* Use when an agent needs to validate whether a specific country is eligible for voucher purchase or redemption before proceeding with a catalog lookup or order. *Not for:* Do not use to retrieve available voucher products or denominations for a country; use a catalog products endpoint instead. **Returns:** Returns a JSON array of objects each containing a 'code' field with an ISO 3166-1 alpha-2 country code, covering 56 supported countries such as US, GB, DE, and NG. **Example:** `GET https://api.reloadpi.com/api/catalog/vouchers/countries` --- ### `fetch-voucher-offers-catalog` **Voucher Offers Catalog** — Returns a paginated list of voucher and gift card offers including offer IDs, brand names, country/region availability, sub-categories, pricing in USD, and product type. *Use when:* Use when an agent needs to browse or search available voucher and gift card products, retrieve offer IDs for downstream purchase flows, or display brand/pricing metadata to a user selecting a gift card. *Not for:* Do not use to redeem or purchase a voucher; this endpoint only lists available offers. Not suitable for real-time price feeds or single-offer lookups by ID. **Returns:** Returns a list array of voucher offer objects, each with offerId, brand, brandName, image URL, country, regions, subTypes, a price object (fixed face value in minor currency units, margin, fee), priceType, and productType. **Example:** `GET https://api.reloadpi.com/api/catalog/vouchers/offers` --- ### `fetch-topup-supported-countries` **ReloadPi Topup Countries** — Returns the full list of ISO 3166-1 alpha-2 country codes supported by the ReloadPi top-up catalog. *Use when:* Use when an agent needs to validate whether a specific country is eligible for a top-up request, or to enumerate all countries available in the ReloadPi catalog before initiating a top-up flow. *Not for:* Do not use to retrieve available top-up products or operators for a country; use a catalog products endpoint instead. Not suitable for real-time operator availability checks. **Returns:** Returns a JSON array of objects each containing a 'code' field with an ISO 3166-1 alpha-2 country code; the real response includes 113 supported countries such as US, NG, IN, BR, and ZA. **Example:** `GET https://api.reloadpi.com/api/catalog/topups/countries` --- ### `fetch-topup-offers-catalog` **ReloadPi Topup Offers Catalog** — Returns a paginated catalog of mobile top-up and bundle offers filtered by country and carrier, including pricing in USD, data/voice/SMS allowances, duration, and regional metadata. *Use when:* Use when an agent needs to browse or search available mobile top-up or bundle offers for a specific country or carrier, including pricing details and allowance specifications before initiating a recharge. *Not for:* Do not use to execute or place a top-up order; this endpoint only retrieves the catalog of available offers. Not suitable for real-time balance checks or number validation. **Returns:** Returns a list array of offer objects each containing offerId, brand, country, pricing in USD cents, data/voice/SMS allowances, duration in days, regions, and subTypes. **Example:** `GET https://api.reloadpi.com/api/catalog/topups/offers` --- ### `fetch-esim-offers-catalog` **ReloadPi eSIM Offers Catalog** — Returns the full catalog of available eSIM plans including country, region, data allowance, duration, pricing, and speed tier subtype for each offer. *Use when:* Use when an agent needs to browse or filter available eSIM plans by country, data size, duration, or speed tier before presenting options to a user or initiating a purchase. *Not for:* Do not use to purchase or activate an eSIM; this endpoint only returns catalog listings. Not suitable for real-time network availability checks. **Returns:** Returns a list array of eSIM offer objects, each with offerId, country, regions, dataGB, dataUnlimited, durationDays, price (integer cents), priceCurrency, subTypes speed tier, and usage notes. **Example:** `GET https://api.reloadpi.com/api/catalog/esims/offers` ---