Overview

The Product Catalog API allows retrieval of a list of products that can be used for placing orders with the Flow1st API. This API uses GET to retrieve the product information and returns a JSON response containing details about each product.

Integrating this will enable Flow1st Products to be shown on the Flow1st Partner’s frontend screens.

Pre Requisites

An access token needs to be generated in order to use this API (see Authentication - Generate Access Token)

API Description

Headers

Header	Description/Value
AccessToken	This is the Access Token field returned from the Authentication - Generate Access Token response. This should be in the format `Bearer <AccessToken>`
Content-Type	`application/vnd.carry1st.products.distributorproduct+json`

URL Format

To retrieve a list of available payment methods, make a GET request to the following endpoint:

GET /api/distributors/products

Response

The API will respond with a JSON object containing an array of products

{
   "products": [
       {
           "id": 10,
           "productId": 143,
           "distributorId": 8,
           "name": "Call of Duty: Mobile",
         "imageLocation": "https://d13ms5efar3wc5.cloudfront.net/eyJidWNrZXQiOiJkZXYtaW1hZ2VzLWNhcnJ5MXN0LXByb2R1Y3RzIiwia2V5IjoiZjExNDc2NjktN2E5Yi00YjU0LWEyMTktMmNhM2IzYjJiNjdhLmpwZy53ZWJwIiwiZWRpdHMiOnsicmVzaXplIjp7IndpZHRoIjo5Nn19LCJ3ZWJwIjp7fX0=",
					"productFulfilmentType": "DIRECT_TOPUP",
           "bundles": [
               {
                   "id": 59,
                   "productId": 143,
                   "productBundleId": 10336,
                   "distributorId": 8,
                   "name": "30 CP",
                   "sku": "codm30cp",
                   "price": 30,
                   "currencyCode": "USD",
                   "fields": [{
                            "id": 14569,
                            "productBundleId": 5343,
                            "name": "userName",
                            "type": "input",
                            "label": "User ID",
                            "multiline": false,
                            "placeholder": "Please enter User ID",
                            "prefix": "",
                            "position": 1
                        },],
                   "createdDate": "2025-09-17 19:42:42",
                   "lastModifiedDate": "2025-09-17 19:42:42"
               },
           ],
           "createdDate": "2025-09-17 19:42:41",
           "lastModifiedDate": "2025-09-17 19:42:41"
       }
   ]
}

The response contains a Product Array, which contains an array of Product Bundles

Product Fields

Name	Type	Description
id	Integer	The identifier of the Flow1st product
productId	Integer	The identifier of the productId
distributorId	Integer	The identifier of the Flow1st Partner
name	String	The name of the product
imageLocation	String	The HTTP location of the product image
productFulfilmentType	String	The type of fulfilment. Possible values are `DIRECT_TOPUP, VOUCHER_CODE, REDIRECT_LINK`
createdDate	String	The timestamp when the product was created
lastModifiedDate	String	The timestamp when the product was updated
bundles	Array[ProductBundle]	An array of bundles

Product Bundle Fields

Name	Type	Description
id	Integer	The product bundle identifier
productId	Integer	The identifier of the product
productBundleId	Integer	The identifier of the product bundle
distributorId	Integer	The identifier of the Flow1st partner
name	String	The name of the product bundle
sku	String	The string identifier of the product to use for Completing Orders
price	Number	The price that will be deducted from the Distributor’s account balance
currencyCode	String	The currency code for the price
fields	Array[Fields]	If a product bundle requires extra fields to be sent in user validation, they will be specified here.
createdDate	String	The timestamp when the product was created
lastModifiedDate	String	The timestamp when the product was updated

"Fields" Properties

These are the properties of the Fields Object.

Name	Type	Description
id	Number	A numeric identifier of the field
productBundleId	Number	A numeric identifier of a product bundle
name	String	The name of the field to use in User Validation APIand Order Completion API
type	String	The type of the field. Possible values are `input` and `select`
label	String	This is the suggested frontend label that can be used for customers
multiline	Boolean	Allows multiple lines
options	Array[Option]	If the `type=select`, then this will be populated with options
placeholder	String	Input placeholder text. This can be used on the frontend
prefix	String	Text prefix for input
position	Number	Display order position. This is used for frontend purposes

Options Properties

Name	Type	Description
label	Number	The frontend label to display to the customer
value	Number	The field value to use in User Validation API and Order Completion API

HTTP Response Codes

The List Payment Method API may return the following HTTP Response Codes:

HTTP Status Code	Name	Description
200	Success	This indicates that the request has been successful
401	Unauthorized	The Access Token might be missing or invalid (see Authentication - Generate Access Token)
403	Forbidden	The credentials provided might not have access to the resources required

Error Handling

See Handling Error Codes for more details on handling error responses.