CSQ Docs
    CSQ Docs
    CSQ API Doc
    • CSQ API Doc
    • Dummy Product Usage Guide
    • Prepaid
    • Recharge
    • Get Parameters
      GET
    • Get Products
      GET
    • Purchase
      POST

      Get Products

      GET
      /pre-paid/recharge/products/{terminalId}/{operatorId}/{account}

      📦 Get Dynamic Products#

      Retrieves the list of available dynamic products for a specific account, such as a mobile number (MSISDN) or a prepaid utility service.

      🔍 Description#

      This method is used when the operator provides dynamic products, which are not predefined and must be queried in real time based on the user's account.

      📥 Path Parameters#

      ParameterTypeDescription
      terminalIdstringIdentifier of the terminal making the request
      operatorIdstringIdentifier of the operator (e.g., telecom or utility)
      accountstringThe user’s account number or MSISDN (e.g., phone number)

      📤 Response#

      Returns a list of dynamic products, each including the following fields:
      dynamicProductId: Unique identifier of the dynamic product (used for purchasing)
      description: Human-readable product description
      amount: Price of the product
      currency: Currency used by the operator (e.g., EUR, USD)
      additionalData (optional): A list of key-value pairs required by the operator to complete the purchase. These may include fields like meterNumber, referenceCode, or other operator-specific inputs.

      🧠 Usage Notes#

      This endpoint should be called before placing a purchase order when dealing with operators that offer dynamic products.
      You can check if an operator supports dynamic products by calling the GET /pre-paid/recharge/parameters/{terminalId}/{operatorId} endpoint and verifying if dynamic: true is present in the response.
      If the response includes additionalData, make sure to collect and submit those values during the purchase request.

      Request

      Path Params
      terminalId
      integer <int32>
      required
      operatorId
      integer <int32>
      required
      account
      string  | null 
      required
      Header Params
      U
      string 
      required
      Default:
      {{U}}
      SH
      string 
      required
      Default:
      {{SH}}
      ST
      string 
      required
      Default:
      {{ST}}

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://evsb.csqworld.com/pre-paid/recharge/products///' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      Body
      rc
      integer <int32>
      optional
      items
      array[object (DynamicProductDto) {8}] 
      optional
      amountToSendX100
      integer <int32>
      optional
      destinationAmountX100
      integer <int32>
      optional
      serviceFeeX100
      integer <int32>
      optional
      totalAmountX100
      integer <int32>
      optional
      destinationCurrency
      string 
      optional
      id
      string 
      optional
      description
      string 
      optional
      additionalData
      array[object (AdditionalDataDto) {2}] 
      optional
      additionalData
      array[object (AdditionalDataDto) {2}] 
      optional
      key
      string 
      optional
      value
      string 
      optional
      Example
      {
    "rc": 0,
    "items": [
        {
            "amountToSendX100": 0,
            "destinationAmountX100": 0,
            "serviceFeeX100": 0,
            "totalAmountX100": 0,
            "destinationCurrency": "string",
            "id": "string",
            "description": "string",
            "additionalData": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ],
    "additionalData": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
      Modified at 2025-07-03 09:49:27
      Previous
      Get Parameters
      Next
      Purchase
      Built with