key
required |
string
|
Stable identifier used to store and retrieve the field value. Submit this verbatim as the
`Key` of the processor field value in a merchant create/update request.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
Human-friendly label for the field. Supplying it on the corresponding field value is optional;
when omitted, the server fills it from this definition.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
Longer description or help text for the field.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
displayType
required |
SetupFieldDisplayType
SetupFieldDisplayType |
Hint for how a UI should render the field (text box, toggle, or dropdown).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Toggle |
| TextField |
| Dropdown |
|
|
fieldType
required |
SetupFieldType
SetupFieldType |
Underlying value type of the field (string, bool, int, datetime).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
options
required |
array of ProcessorFieldOptionDto
array of ProcessorFieldOptionDto |
For dropdown fields, the selectable options as explicit `{value, label}` pairs. Submit
the option's `Value` verbatim as the field value. When a field has no distinct backing
wire code, `Value` equals `Label`. Null for non-dropdown fields. This is the
preferred shape for closed-set fields.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
dropdownList
required |
array of string
array of |
For dropdown fields, the labels presented to the operator. Aligned by index with
`dropdownValues` when backing values differ from the labels.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
dropdownValues
required |
array of string
array of |
For dropdown fields, the backing values stored for each option. When null, the label from
`dropdownList` is also the stored value.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isRequired
required |
boolean
|
Whether a value must be supplied for this field, <b>effective for the requested payment-type
selection</b>. When the config-schema request is scoped to a set of payment types, the response
contains exactly the fields applicable to that selection and `isRequired` reflects
it, so the returned set with `IsRequired == true` is the required-field minimum for that
selection. Fields outside the selection are omitted entirely (see
`applicablePaymentTypes`).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
category
required |
string
|
Grouping category for UI layout (e.g. "Default", "Credit", "Debit", "EBT", "PAYFAC").
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
position
required |
integer (int32)
|
Relative ordering among fields. Fields are returned ordered by this value.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isSecret
required |
boolean
|
Whether the field holds a secret (credential) value. Secret values are encrypted at rest and
are never returned in plaintext; clients should treat secret fields as write-only.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
validationRegex
required |
string
|
Optional regular expression the submitted string value must match.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
maxLength
required |
integer (int32)
|
Maximum character length for string values. Null means no limit.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
validationMessage
required |
string
|
Human-readable message shown when validation fails. When null, a generic message is generated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
applicablePaymentTypes
required |
array of string
array of |
Payment type <b>names</b> this field applies to: the same tokens as
`supportedPaymentTypes` and
`name`, so a client can correlate a field to a payment
type with one consistent token (no side lookup). Null or empty means the field applies to every
payment type. When a request scopes the schema to a subset of payment types, fields outside that
subset are omitted from the response.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
defaultValue
required |
string
|
Optional default value pre-populated when creating a new processor profile.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|