{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-vas/vas.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"List products","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"list-products"},"children":["List products"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list products phase is a transaction consisting of a call to obtain product information about the available products. This information is used to process airtime purchase requests for that service provider."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This list products API call is used to retrieve product information from the master product list (electronic catalogue) that is maintained by the originating system via Electrum. It is up to the originating system to decide how to display the information to consumers wishing to buy an airtime product."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operations-and-messages"},"children":["Operations and Messages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This transaction consists of a single set of messages described by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listProducts"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/other/listproducts"},"children":["operation"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET/products"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response payload: Array of product objects"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error payload: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorDetail"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message-flows"},"children":["Message flows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The sections below describe successful product list transactions and error scenarios."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"successful-list-products"},"children":["Successful List Products"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/products"]}," API endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listProducts"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/other/listproducts"},"children":["operation"]},")."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The originating system receives a list of available products."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/successful-list-products-phase.cfa904d20fdd7b5784bd8a30451f4f129c6d73a3167f105d7c94fca8a5d9a5e5.25fce2f6.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-at-originating-system"},"children":["Error at Originating System"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/products"]}," API endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listProducts"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/other/listproducts"},"children":["operation"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error occurs at the originating system, which does not receive the product list. No further messaging is required. The originating system can try the transaction again."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-at-os-during-list-products-phase.66ff15777fcc18e3b1cb2f3a744091a45efe7b852ef40569cb4325440b4b90ac.25fce2f6.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-upstream"},"children":["Error Upstream"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/products"]}," API endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listProducts"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/other/listproducts"},"children":["operation"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error occurs at the Electrum or with the catalogue system."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system receives an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorDetail"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/schema/errordetail"},"children":["message"]},". No further messaging is required. The originating system can try the transaction again."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-upstream-during-list-products-phase.0d4db013a96092fe82cc0606fcbff05c8d568f8b7b03c63c9cb7b87689408381.25fce2f6.png","alt":"alt text"},"children":[]}]}]},"headings":[{"value":"List products","id":"list-products","depth":1},{"value":"Operations and Messages","id":"operations-and-messages","depth":2},{"value":"Message flows","id":"message-flows","depth":2},{"value":"Successful List Products","id":"successful-list-products","depth":2},{"value":"Error at Originating System","id":"error-at-originating-system","depth":2},{"value":"Error Upstream","id":"error-upstream","depth":2}],"frontmatter":{"seo":{"title":"List products"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/airtime-direct-top-up/list-products","userData":{"isAuthenticated":false,"teams":["anonymous"]}}