List user-defined fields for a terminal

posthttps://report.tranzila.com/v1/terminals/settings/fields/list

Returns the configuration of all user-defined fields (user_defined_1 through user_defined_25) that have been set up for the specified terminal.

Use this endpoint to discover the api_parameter_name values available for your terminal before constructing ufields filter queries against /v1/transaction.

Response Fields

Field	Description
`terminal_id`	Terminal name
`field_id`	Slot number (1–25), corresponding to `user_defined_N` in transaction responses
`api_parameter_name`	The name to use in `ufields[].name` when filtering
`caption`	Human-readable label (may be in Hebrew)
`default_value`	Default value if not supplied in a transaction
`display_order`	Display ordering in the Tranzila dashboard
`mandatory`	Whether the field is required (`Y` / `N`)
`data_type`	Always `string` for user-defined fields
`update_date`	Timestamp of last configuration change

Request

Body

application/json

terminal_namestringrequired

Your Tranzila terminal name

Example:yourTerminalName

Responses

List of configured user-defined fields for the terminal

Response body

response.json

JSON

1[
2  {
3    "terminal_id": "yourTerminalName",
4    "field_id": 20,
5    "api_parameter_name": "order_ref",
6    "caption": "Order Reference",
7    "default_value": null,
8    "display_order": null,
9    "mandatory": "N",
10    "data_type": "string",
11    "update_date": "2024-01-01 10:00:00"
12  },
13  {
14    "terminal_id": "yourTerminalName",
15    "field_id": 5,
16    "api_parameter_name": "email",
17    "caption": "דואר אלקטרוני",
18    "default_value": null,
19    "display_order": null,
20    "mandatory": "N",
21    "data_type": "string",
22    "update_date": "2024-01-01 10:00:00"
23  },
24  {
25    "terminal_id": "yourTerminalName",
26    "field_id": 4,
27    "api_parameter_name": "contact",
28    "caption": "איש קשר",
29    "default_value": null,
30    "display_order": null,
31    "mandatory": "N",
32    "data_type": "string",
33    "update_date": "2024-01-01 10:00:00"
34  }
35]
36

Body

1{
2  "terminal_name": "yourTerminalName"
3}
4

Request Sample

curl --request POST \
  --url https://report.tranzila.com/v1/terminals/settings/fields/list \
  --header 'Content-Type: application/json' \
  --data '{  "terminal_name": "yourTerminalName"}'

Response Example: Example

1[
2  {
3    "terminal_id": "yourTerminalName",
4    "field_id": 20,
5    "api_parameter_name": "order_ref",
6    "caption": "Order Reference",
7    "default_value": null,
8    "display_order": null,
9    "mandatory": "N",
10    "data_type": "string",
11    "update_date": "2024-01-01 10:00:00"
12  },
13  {
14    "terminal_id": "yourTerminalName",
15    "field_id": 5,
16    "api_parameter_name": "email",
17    "caption": "דואר אלקטרוני",
18    "default_value": null,
19    "display_order": null,
20    "mandatory": "N",
21    "data_type": "string",
22    "update_date": "2024-01-01 10:00:00"
23  },
24  {
25    "terminal_id": "yourTerminalName",
26    "field_id": 4,
27    "api_parameter_name": "contact",
28    "caption": "איש קשר",
29    "default_value": null,
30    "display_order": null,
31    "mandatory": "N",
32    "data_type": "string",
33    "update_date": "2024-01-01 10:00:00"
34  }
35]
36