CardConfiguration class abstract

CardConfiguration

Properties:

  • activation - The activation label attached to the card that contains the activation instructions. This field overrides the activation label design ID defined in the card configuration profile.
  • activationUrl - Your app's URL, if you want to activate cards through your app. For example, my-app://ref1236a7d. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. Maximum length: 255 characters.
  • bulkAddress - Overrides the shipment bulk address defined in the card configuration profile.
  • cardImageId - The unique identifier of the card image. This image is printed on the full front of the card.
  • carrier - The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile.
  • carrierImageId - The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.
  • configurationProfileId - The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. You can override some of the existing settings in the configuration profile by providing the corresponding fields in the configuration object. For example, send the shipmentMethod to override the logistics company defined in the card configuration profile.
  • currency - The three-letter ISO-4217 currency code of the card. For example, EUR. This field overrides the existing currency setting on the card configuration profile.
  • envelope - Overrides the envelope design ID defined in the card configuration profile.
  • insert - Any additional material, such as marketing material, that is shipped together with the card. This field overrides the insert design ID defined in the card configuration profile.
  • language - The two-letter ISO-639-1 language code of the card. For example, en.
  • logoImageId - The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.
  • pinMailer - The letter on which the PIN of the card is printed. This field overrides the PIN mailer design ID defined in the card configuration profile.
  • shipmentMethod - The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
Annotations
  • @BuiltValue.new()

Constructors

CardConfiguration([void updates(CardConfigurationBuilder b)])
factory

Properties

activation → String?
The activation label attached to the card that contains the activation instructions. This field overrides the activation label design ID defined in the card configuration profile.
no setter
activationUrl → String?
Your app's URL, if you want to activate cards through your app. For example, my-app://ref1236a7d. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. Maximum length: 255 characters.
no setter
bulkAddress → BulkAddress?
Overrides the shipment bulk address defined in the card configuration profile.
no setter
cardImageId → String?
The unique identifier of the card image. This image is printed on the full front of the card.
no setter
carrier → String?
The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile.
no setter
carrierImageId → String?
The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.
no setter
configurationProfileId → String
The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. You can override some of the existing settings in the configuration profile by providing the corresponding fields in the configuration object. For example, send the shipmentMethod to override the logistics company defined in the card configuration profile.
no setter
currency → String?
The three-letter ISO-4217 currency code of the card. For example, EUR. This field overrides the existing currency setting on the card configuration profile.
no setter
envelope → String?
Overrides the envelope design ID defined in the card configuration profile.
no setter
hashCode → int
The hash code for this object.
no setterinherited
insert → String?
Any additional material, such as marketing material, that is shipped together with the card. This field overrides the insert design ID defined in the card configuration profile.
no setter
language → String?
The two-letter ISO-639-1 language code of the card. For example, en.
no setter
logoImageId → String?
The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.
no setter
pinMailer → String?
The letter on which the PIN of the card is printed. This field overrides the PIN mailer design ID defined in the card configuration profile.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shipmentMethod → String?
The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CardConfigurationBuilder)) → CardConfiguration
Rebuilds the instance.
inherited
toBuilder() → CardConfigurationBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<CardConfiguration>
no setter