MetadataConfigItem

One configuration field that processors of a brand expect, without a value. paymentProcessorConfig returns these fields to build the form that adds a processor.

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

Fields

MetadataConfigItem.key ● String! non-null scalar

Field key, to send as MetadataItemInput.key. Nested fields use dot notation, for example petitionParams.merchantCode.

MetadataConfigItem.type ● MetadataItemType! non-null enum

Kind of value the field holds. It decides how the value is written as a string.

MetadataConfigItem.label ● String scalar

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

MetadataConfigItem.possibleValues ● [String!] list scalar

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

MetadataConfigItem.regex ● String scalar

Regular expression the value must match when it is saved.

MetadataConfigItem.secret ● Boolean scalar

true for a credential. Reads return its value masked, never in clear.

MetadataConfigItem.required ● Boolean scalar

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

MetadataConfigItem.default ● String scalar

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

MetadataConfigItem.example ● String scalar

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

MetadataConfigItem.internal ● Boolean scalar

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

Member Of

PaymentProcessorConfig object