# HppResolvedCustomFieldDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

One merchant custom field a hosted payment page actually offers, projected onto the page's read
model. Read-only: custom fields are defined once per merchant (`Merchant.CustomFields`) and a
page only selects from them, so this is reported by the API and never accepted from a caller.

## Fields
- `name` (string): The field's name. This is the key the value is carried under: in a session's prefilled fields,  and in the transaction's `customFields` collection. (nullable)
- `label` (string): The text the page labels the input with: the merchant's description of the field when one is  configured, otherwise `name`. (nullable)
- `position` (integer(int32)): The field's position in the page's rendering order, lowest first. The page breaks ties on  `name`; the list is already returned in that order.
- `isRequired` (boolean): The merchant's requiredness setting for the field, reported as configured.
- `isReadOnly` (boolean): Whether the page displays the field without letting the customer edit it. A read-only field  still submits the value the session prefilled it with.
- `isNumeric` (boolean): Whether the field accepts only a number.
- `isRenderedToPayer` (boolean): Whether the payer sees the field on the page. `false` marks a field the merchant keeps  hidden but opted in to carrying a value supplied through the session API: pass it in the  session's prefilled fields and the platform stamps it onto the resulting transaction. Those  fields are reported here precisely because the API is the only way to use them.
- `maxLength` (integer(int32)): The number of characters a value may carry: the narrower of the merchant's configured limit and  the platform ceiling. A numeric field reports the platform ceiling, which is what its rules  enforce.
- `decimalPlaces` (integer(int32)): Decimal places a numeric value may carry. `null` when the field is not numeric. (nullable)
- `numericMinValue` (number(double)): Lowest accepted value for a numeric field. `null` when the field is not numeric. (nullable)
- `numericMaxValue` (number(double)): Highest accepted value for a numeric field. `null` when the field is not numeric. (nullable)
- `regEx` (string): The merchant's optional regular expression the value has to match. `null` when the merchant  configured none. A pattern that does not compile is ignored rather than failing the submit. (nullable)
- `regExErrorMessage` (string): The message the page shows when `regEx` rejects the value, when the merchant wrote  one. `null` falls back to a generic message. (nullable)
- `isMultiValue` (boolean): Whether the field carries a list of values rather than a single value. A multi-value field is  prefilled through the session's `prefilledListFields` and reaches the transaction as  `customFields[].values`; the page renders the list read-only. A single value sent for it  is still accepted and mirrored into the list.
- `maxValues` (integer(int32)): The largest number of values a multi-value field accepts, after the platform default and  ceiling are applied. `null` when the field is not multi-value. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.