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 Parameters

      GET
      /pre-paid/recharge/parameters/{terminalId}/{operatorId}
      prepaid-recharge-controller

      📘 Get Parameters — API Explanation#

      The Get Parameters endpoint provides essential metadata required to correctly perform a prepaid recharge transaction for a specific terminal and operator. It helps clients dynamically discover which fields must be included in a purchase request, and whether the product is dynamic or not.

      🔗 Endpoint#

      GET /pre-paid/recharge/parameters/{terminalId}/{operatorId}
      terminalId (path, integer): The ID of the terminal initiating the transaction.
      operatorId (path, integer): The ID of the mobile or prepaid operator.
      Headers Required:
      U: User identifier (usually an authentication token).
      SH: Session hash or signature.
      ST: Session timestamp or token.

      ✅ Purpose#

      This method tells you:
      Whether the operator uses dynamic products (dynamic: true)
      What fields (like receiverEmail, documentNumber, etc.) must be included in the purchase.
      Which field acts as the identifier for dynamic products (dynamicField).

      📌 Example Use Case#

      Before calling the Recharge Purchase API, you must:
      1.
      Call Get Parameters using your terminalId and operatorId.
      2.
      Check if the product is dynamic (dynamic: true).
      If so, use Get Products to fetch product list.
      3.
      Review parameters[] to determine which fields must be sent (e.g., documentNumber, receiverEmail, etc.).
      4.
      Build the request body accordingly and call Recharge Purchase.

      Request

      Path Params
      terminalId
      integer <int32>
      required
      operatorId
      integer <int32>
      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/parameters//' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      OK
      Body
      rc
      integer <int32>
      optional
      message
      string 
      optional
      dynamic
      boolean 
      optional
      dynamicField
      string 
      optional
      parameters
      array[object (PrepaidRechargeParameter) {2}] 
      optional
      field
      string 
      optional
      labels
      object 
      optional
      Example
      {
    "rc": 0,
    "message": "string",
    "dynamic": true,
    "dynamicField": "string",
    "parameters": [
        {
            "field": "string",
            "labels": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}
      Modified at 2025-07-02 15:11:11
      Next
      Get Products
      Built with