MetadataItem

One configuration value of a processor the merchant holds a contract with: the field definition (see MetadataConfigItem) and its stored value.

type MetadataItem {
  key: String!
  value: String
  type: MetadataItemType!
  label: String
  possibleValues: [String!]
  regex: String
  secret: Boolean
  required: Boolean
  default: String
  example: String
  internal: Boolean
}

Fields

MetadataItem.key ● String! non-null scalar

Field key. Nested fields use dot notation.

MetadataItem.value ● String scalar

Stored value, as a string in the format of type. The default when no value is stored, and null when there is neither. A secret value is masked: ••••, followed by its last 4 characters when it has 16 characters or more. To keep a secret on an update, send the masked value back unchanged.

MetadataItem.type ● MetadataItemType! non-null enum

Kind of value the field holds.

MetadataItem.label ● String scalar

Field label. When the processor sets none, the label is built from the key.

MetadataItem.possibleValues ● [String!] list scalar

Allowed values. A save checks them on STRING fields only.

MetadataItem.regex ● String scalar

Regular expression the value must match when it is saved.

MetadataItem.secret ● Boolean scalar

true for a credential. value is masked.

MetadataItem.required ● Boolean scalar

true when the field needs a value. A processor without a value for it has the status UNAVAILABLE.

MetadataItem.default ● String scalar

Value saved when the field is left out, as a string in the format of type.

MetadataItem.example ● String scalar

Example value. The dashboard shows it as the placeholder of the field.

MetadataItem.internal ● Boolean scalar

Always null: fields for MONEI use only are not returned.

Member Of

PaymentProcessor object