Get Countries

This endpoint returns the list of available countries for a given terminal, allowing clients to begin a location-based product flow. It is typically the first step in selecting a geographic context for physical or virtual product delivery.

🔍 Description

Use this method to:

Retrieve the display labels for the country selection field.

Identify the internal field name (countryId) used in subsequent requests.

Determine the next endpoint to call (nextPath) and the required parameter (nextField) for continuing the dynamic flow.

This method does not return simply a list of countries. Instead, it provides structural metadata to guide the dynamic flow.

📥 Request Details

Method: GET

Authentication: Required

Path Parameter:

terminalId (integer): Unique identifier of the terminal making the request

📤 Response

Returns an array of metadata objects with key information to follow the dynamic flow. Each object includes:

Field	Type	Description
`countryId`	integer	Unique identifier for the country
`name`	string	Display name of the country
`nextPath`	string	Relative path of the next endpoint to call, with placeholders, including the `levelId`at the end.
`nextField`	string	Id of the name of the field that should be used in the next step of the dynamic flow, as defined in the Get Labels response.

Example Response

[
  {
    "countryId": 1,
    "name": "Spain",
    "nextPath": "/physical-products/categories/{terminalId}/1",
    "nextField": "categoryId"
  },
  {
    "countryId": 2,
    "name": "Mexico",
    "nextPath": "/physical-products/categories/{terminalId}/2",
    "nextField": "categoryId"
  }
]

🧠 Usage Notes

This method is typically used to initialize the flow and configure UI labels dynamically.

The nextPath and nextField guide the client to the next step in the product selection process.

The actual list of countries is retrieved in a later step, once the flow is activated.

application/json

Body

array of:

countryId

integer

required

name

string

required

nextPath

string

required

nextField

string

required

Example

[
    {
        "countryId": 1,
        "name": "country",
        "nextPath": "/physical-products/{{nextPath}}/{{terminalId}}/{{levelId}}",
        "nextField": "{nextField}"
    }
]

🔍 Description

📥 Request Details

📤 Response

Example Response

🧠 Usage Notes

Request

Request samples

Responses

Get Countries

🔍 Description#

📥 Request Details#

📤 Response#

Example Response#

🧠 Usage Notes#

Request

Request samples

Responses

🔍 Description

📥 Request Details

📤 Response

Example Response

🧠 Usage Notes