Product lookup

The product lookup phase is a transaction consisting of a call to obtain product information about the available products. This information is used to process voucher provision requests for that service provider.

Operations and Messages

This transaction consists of a single set of messages described by the lookupProducts operation, GET /products.

• Response payload: ProductsLookupResponse
• Error payload: ErrorDetail

Message Flows

The sections below describe successful product lookup transactions and error scenarios.

Successful Product Lookup

1. The originating system sends a GET call to the /products API endpoint lookupProducts.
2. The API responds with a ProductsLookupResponse message payload.
3. The originating system receives a list of available products.

Error at Originating System

1. The originating system sends a GET call to the /products API endpoint lookupProducts.
2. The API responds with a ProductsLookupResponse message payload.
3. An error occurs at the originating system.
4. The transaction is considered failed. No further action is required, however, the originating system should attempt the transaction again, or the previous day's product list can be used.

Error Upstream

1. The originating system sends a GET call to the /products API endpoint lookupProducts.
2. An error is encountered at Electrum or the Service Provider.
3. The API responds to the originating system with an ErrorDetail message payload.
4. No further action is required, however, the originating system should attempt the transaction again, or the previous day's product list can be used.