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.

STRUCTURE

✓ - 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
description varchar(256) ? Hint text or extended field description
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)
min int(10) Maximal value (integer) or maximal length (all other formats)

EXAMPLE

{
    "key": "full_name",
    "label": "Full Name",
    "description": "Your full name",
    "required": 0,
    "format": "text",
    "min": 0,
    "max": 50
}