Praxis Wiki logo

Objects Input Field

The gateway input field structure defined the descriptor of an input field presented to customer, or data format to be sent over API.


✓ - required value
? - optional, value or null
✕ - always appears as null

Variable Type Description
key varchar(32) The parameter name as it appears in JSON
label varchar(50) Label for the input
default_value varchar(256) Represents the initial content or pre-selected option
required int(1) Whether the field is required
format varchar(32) The field format. Possible values are: integer, text, email, phone, url
min int(10) Minimal value (integer) or minimal length (all other formats)
max int(10) Maximum value (integer) or maximum length (all other formats)
options varchar(256) ? Options allowed to be selected (applies only if format is "select")


    "key": "full_name",
    "label": "Full Name",
    "default_value": null,
    "required": 0,
    "format": "text",
    "min": 0,
    "max": 50
    "key": "country",
    "label": "Customer Country",
    "default_value": "ua",
    "required": null,
    "format": "select",
    "min": 0,
    "max": 50,
    "options": "{\"ua\":\"Ukraine\",\"us\":\"United States\"}"