List products
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.
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.
Operations and Messages
This transaction consists of a single set of messages described by the listProducts operation, GET/products.
- Response payload: Array of product objects
- Error payload:
ErrorDetail
Message flows
The sections below describe successful product list transactions and error scenarios.
Successful List Products
The originating system sends a
GETcall to the/productsAPI endpoint (listProductsoperation).The originating system receives a list of available products.
Error at Originating System
- The originating system sends a
GETcall to the/productsAPI endpoint (listProductsoperation). - 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.
Error Upstream
- The originating system sends a
GETcall to the/productsAPI endpoint (listProductsoperation). - An error occurs at the Electrum or with the catalogue system.
- The originating system receives an
ErrorDetailmessage. No further messaging is required. The originating system can try the transaction again.
