Package com.adyen.model.configurationwebhooks

Class CardConfiguration

  • public class CardConfiguration
extends Object
    CardConfiguration

    • Constructor Detail

      • CardConfiguration

        public CardConfiguration()

    • Method Detail

      • activation

        public CardConfiguration activation​(String activation)
        Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.
        Parameters:
        activation -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getActivation

        public String getActivation()
        Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.
        Returns:
        activation

      • setActivation

        public void setActivation​(String activation)
        Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.
        Parameters:
        activation -

      • activationUrl

        public CardConfiguration activationUrl​(String 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.
        Parameters:
        activationUrl -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getActivationUrl

        public String getActivationUrl()
        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.
        Returns:
        activationUrl

      • setActivationUrl

        public void setActivationUrl​(String 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.
        Parameters:
        activationUrl -

      • bulkAddress

        public CardConfiguration bulkAddress​(BulkAddress bulkAddress)
        bulkAddress
        Parameters:
        bulkAddress -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getBulkAddress

        public BulkAddress getBulkAddress()
        bulkAddress
        Returns:
        bulkAddress

      • setBulkAddress

        public void setBulkAddress​(BulkAddress bulkAddress)
        bulkAddress
        Parameters:
        bulkAddress -

      • cardImageId

        public CardConfiguration cardImageId​(String cardImageId)
        The ID of the card image. This is the image that will be printed on the full front of the card.
        Parameters:
        cardImageId -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getCardImageId

        public String getCardImageId()
        The ID of the card image. This is the image that will be printed on the full front of the card.
        Returns:
        cardImageId

      • setCardImageId

        public void setCardImageId​(String cardImageId)
        The ID of the card image. This is the image that will be printed on the full front of the card.
        Parameters:
        cardImageId -

      • carrier

        public CardConfiguration carrier​(String carrier)
        Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.
        Parameters:
        carrier -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getCarrier

        public String getCarrier()
        Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.
        Returns:
        carrier

      • setCarrier

        public void setCarrier​(String carrier)
        Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.
        Parameters:
        carrier -

      • carrierImageId

        public CardConfiguration carrierImageId​(String carrierImageId)
        The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
        Parameters:
        carrierImageId -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getCarrierImageId

        public String getCarrierImageId()
        The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
        Returns:
        carrierImageId

      • setCarrierImageId

        public void setCarrierImageId​(String carrierImageId)
        The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
        Parameters:
        carrierImageId -

      • configurationProfileId

        public CardConfiguration configurationProfileId​(String configurationProfileId)
        The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.
        Parameters:
        configurationProfileId -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getConfigurationProfileId

        public String getConfigurationProfileId()
        The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.
        Returns:
        configurationProfileId

      • setConfigurationProfileId

        public void setConfigurationProfileId​(String configurationProfileId)
        The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.
        Parameters:
        configurationProfileId -

      • currency

        public CardConfiguration currency​(String currency)
        The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.
        Parameters:
        currency -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getCurrency

        public String getCurrency()
        The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.
        Returns:
        currency

      • setCurrency

        public void setCurrency​(String currency)
        The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.
        Parameters:
        currency -

      • envelope

        public CardConfiguration envelope​(String envelope)
        Overrides the envelope design ID defined in the `configurationProfileId`.
        Parameters:
        envelope -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getEnvelope

        public String getEnvelope()
        Overrides the envelope design ID defined in the `configurationProfileId`.
        Returns:
        envelope

      • setEnvelope

        public void setEnvelope​(String envelope)
        Overrides the envelope design ID defined in the `configurationProfileId`.
        Parameters:
        envelope -

      • insert

        public CardConfiguration insert​(String insert)
        Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.
        Parameters:
        insert -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getInsert

        public String getInsert()
        Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.
        Returns:
        insert

      • setInsert

        public void setInsert​(String insert)
        Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.
        Parameters:
        insert -

      • language

        public CardConfiguration language​(String language)
        The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.
        Parameters:
        language -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getLanguage

        public String getLanguage()
        The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.
        Returns:
        language

      • setLanguage

        public void setLanguage​(String language)
        The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.
        Parameters:
        language -

      • logoImageId

        public CardConfiguration logoImageId​(String logoImageId)
        The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.
        Parameters:
        logoImageId -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getLogoImageId

        public String getLogoImageId()
        The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.
        Returns:
        logoImageId

      • setLogoImageId

        public void setLogoImageId​(String logoImageId)
        The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.
        Parameters:
        logoImageId -

      • pinMailer

        public CardConfiguration pinMailer​(String pinMailer)
        Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.
        Parameters:
        pinMailer -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getPinMailer

        public String getPinMailer()
        Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.
        Returns:
        pinMailer

      • setPinMailer

        public void setPinMailer​(String pinMailer)
        Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.
        Parameters:
        pinMailer -

      • shipmentMethod

        public CardConfiguration shipmentMethod​(String shipmentMethod)
        Overrides the logistics company defined in the `configurationProfileId`.
        Parameters:
        shipmentMethod -
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getShipmentMethod

        public String getShipmentMethod()
        Overrides the logistics company defined in the `configurationProfileId`.
        Returns:
        shipmentMethod

      • setShipmentMethod

        public void setShipmentMethod​(String shipmentMethod)
        Overrides the logistics company defined in the `configurationProfileId`.
        Parameters:
        shipmentMethod -

      • equals

        public boolean equals​(Object o)
        Return true if this CardConfiguration object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static CardConfiguration fromJson​(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CardConfiguration given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CardConfiguration
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CardConfiguration

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CardConfiguration to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException