CustomField
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Values
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.
Fields
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) |
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 |
nullablemin length 3max length 50pattern ^[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*$
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.
| ||||||||||||
notes
required |
array of EntityNote array of EntityNote |
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.
| ||||||||||||
Fields of each EntityNote: This body has no documented fields. | ||||||||||||||
tags
required |
array of EntityTag array of EntityTag |
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.
| ||||||||||||
Fields of each EntityTag:
This body has no documented fields. | ||||||||||||||
isNumeric
required |
boolean | Conditional: When IsMultiValue is true.
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.
| ||||||||||||
decimalPlaces
required |
integer (int32) | Conditional: When IsNumeric is true. Range: 0 to 2.
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) | Conditional: When IsNumeric is false. Range: 0 to 300.
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.
| ||||||||||||
regEx
required |
string | Conditional: When RegEx is not empty.
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.
| ||||||||||||
regExErrorMessage
required |
string | Conditional: When RegExErrorMessage is not empty. Max length: 100.
nullablemax length 100
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 |
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.
| ||||||||||||
isEnabled
required |
boolean |
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 | Conditional: When Description is not empty. Max length: 100.
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.
| ||||||||||||
numericMinValue
required |
number (double) | For numeric fields, the minimum value allowed. Negative minimums are permitted: a custom
field is merchant-defined metadata rather than a monetary amount, so ranges that span or sit
below zero (adjustments, offsets, deltas, temperatures) are legitimate. The value is inert
unless `isNumeric` is set, and is validated only in that case.
Conditional: When IsNumeric is true. Range: -1000000000 to 1000000000.
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.
| ||||||||||||
numericMaxValue
required |
number (double) | For numeric fields, the maximum value allowed. It must be greater than or equal to
`numericMinValue` but is not required to be positive, since a field whose whole
range is negative is valid. The value is inert unless `isNumeric` is set, and is
validated only in that case.
Conditional: When IsNumeric is true. Range: -1000000000 to 1000000000.
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) |
min 0
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.
| ||||||||||||
virtualTerminal
required |
CustomFieldPresence CustomFieldPresence | Presence settings for the Virtual Terminal, which collects this field from the operator when
`visible` is set.
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.
| ||||||||||||
Fields of CustomFieldPresence:
This body has no documented fields. | ||||||||||||||
hostedPaymentPage
required |
CustomFieldPresence CustomFieldPresence |
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.
| ||||||||||||
Fields of CustomFieldPresence:
This body has no documented fields. | ||||||||||||||
transactionReports
required |
CustomFieldTransactionReportsPresence CustomFieldTransactionReportsPresence | Presence settings for the surfaces that list a transaction's captured custom fields: the
transaction detail page and the receipt. Only `visible` is
honoured.
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.
| ||||||||||||
Fields of CustomFieldTransactionReportsPresence:
This body has no documented fields. | ||||||||||||||
showOnSaveCardSessions
required |
boolean | Whether this field is offered on a save-card hosted payment page session (one that stores the
card without charging it). Defaults to off: most custom fields carry charge metadata (invoice
number, purchase order, department) that is meaningless on a page whose only outcome is a
stored card, so a field is suppressed on those sessions unless the merchant opts it in.
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.
| ||||||||||||
legacyNumber
required |
integer (int64) | The integer key the v1 API addresses this definition by. Server-owned: allocated once, when
the definition is first saved, and never reassigned afterwards.
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.
| ||||||||||||
isMultiValue
required |
boolean | Whether a transaction carries a list of values for this field rather than a single value.
A multi-value field is submitted through `TrxCustomField.Values`, prefilled on a hosted
page session through `prefilledListFields`, and captured one value per line on the
Virtual Terminal. The single `value` member keeps working on a multi-value definition:
it is carried unchanged and mirrored into the list as its one item.
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.
| ||||||||||||
maxValues
required |
integer (int32) | For a multi-value field, the largest number of values a transaction may carry. Unset reads as
`DefaultMaxValues`; the platform ceiling is
`MaxValuesCeiling`. Inert unless `isMultiValue` is set,
and validated only in that case.
Conditional: When IsMultiValue is true and MaxValues is not null. Range: 1 to 250.
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.
| ||||||||||||
This model has no documented fields.