Skip to main content

BenefitsOfferingCardsConfiguration

Describes the availability and state of the Cards feature for a Benefits Offering. Cards describe how spend can be realized against a physical and/or virtual card program.

type BenefitsOfferingCardsConfiguration {
  available: Boolean!
  cards: [BenefitsOfferingCardConfiguration!]
  enabled: Boolean!
  id: ID!
  mutuallyExclusiveWith: [ConfigurableBenefitsOfferingFeature!]
  validationRules: BenefitsOfferingCardValidationConfiguration
}

Fields​

BenefitsOfferingCardsConfiguration.available ● Boolean! non-null scalar​

If true, Cards are available for this Offering type. This is a read-only attribute. If false, enabled must be false and all attributes MUST BE unsettable.

BenefitsOfferingCardsConfiguration.cards ● [BenefitsOfferingCardConfiguration!] list object​

The card types and rules configured for the Offering.

BenefitsOfferingCardsConfiguration.enabled ● Boolean! non-null scalar​

If true, Cards are enabled for this Offering.

BenefitsOfferingCardsConfiguration.id ● ID! non-null scalar​

The ID of this configurable feature.

BenefitsOfferingCardsConfiguration.mutuallyExclusiveWith ● [ConfigurableBenefitsOfferingFeature!] list enum​

If present, this feature is mutually exclusive with all features defined here. Client can configure this feature, or one or more of the features in this definition, but this feature cannot be configured if any features in this definition are configured. Client should use this for UI/X controls.

BenefitsOfferingCardsConfiguration.validationRules ● BenefitsOfferingCardValidationConfiguration object​

Validation rules governing the Rollover feature. Present only if the feature is available.

Member of​

BenefitsOfferingConfiguration object