📘 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:

Call Get Parameters using your terminalId and operatorId.

Check if the product is dynamic (dynamic: true).
If so, use Get Products to fetch product list.

Review parameters[] to determine which fields must be sent (e.g., documentNumber, receiverEmail, etc.).

Build the request body accordingly and call Recharge Purchase.

application/json

Body

Example

{
    "rc": 0,
    "message": "string",
    "dynamic": true,
    "dynamicField": "string",
    "parameters": [
        {
            "field": "string",
            "labels": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}

Get Parameters

📘 Get Parameters — API Explanation

🔗 Endpoint

✅ Purpose

📌 Example Use Case

Request

Request Code Samples

Responses

Get Parameters

📘 Get Parameters — API Explanation#

🔗 Endpoint#

✅ Purpose#

📌 Example Use Case#

Request

Request Code Samples

Responses

📘 Get Parameters — API Explanation

🔗 Endpoint

✅ Purpose

📌 Example Use Case