Institution

Fields

• id string uuid required

  The unique identifier of the institution.

• name string required

  The unique name of the institution.

  max length250
• friendlyName string required

  The display name of the institution for consumers.

  max length250
• logo string uri

  A displayable logo or descriptive image of the institution.

• available boolean required

  Whether the institution is available to transact with.

• offlineMessage string

  If the institution is not available to transact with, this user friendly offline message will be returned.

• conditions array of Condition

  Any conditions that govern whether or not the use of this institution is allowed. For example some institutions may have a minimum or maximum allowed value which would need to be considered when using the institution.

  Fields of Condition

  • name string required

    The name of the property to which the condition applies.

  • operator string required

    The operator indicating how this condition is enforced.

    values"<""<=""==""!="">="">"
  • value string required

    The value which the condition will enforce on the property.

  Open Condition on its own page