Package com.adyen.model.balanceplatform

Class CardConfiguration

  • public class CardConfiguration
extends Object
    CardConfiguration

    • Constructor Detail

      • CardConfiguration

        public CardConfiguration()

    • Method Detail

      • activation

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

      • getActivation

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

      • setActivation

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

        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 - 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:
        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 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.

      • 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 - 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

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

      • getBulkAddress

        public BulkAddress getBulkAddress()
        Get bulkAddress
        Returns:
        bulkAddress

      • setBulkAddress

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

      • cardImageId

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

      • getCardImageId

        public String getCardImageId()
        The unique identifier of the card image. This image is printed on the full front of the card.
        Returns:
        cardImageId The unique identifier of the card image. This image is printed on the full front of the card.

      • setCardImageId

        public void setCardImageId​(String cardImageId)
        The unique identifier of the card image. This image is printed on the full front of the card.
        Parameters:
        cardImageId - The unique identifier of the card image. This image is printed on the full front of the card.

      • carrier

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

      • getCarrier

        public String getCarrier()
        The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile.
        Returns:
        carrier The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile.

      • setCarrier

        public void setCarrier​(String carrier)
        The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile.
        Parameters:
        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

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

      • getCarrierImageId

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

      • setCarrierImageId

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

      • configurationProfileId

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

      • getConfigurationProfileId

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

      • setConfigurationProfileId

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

        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**. This field overrides the existing currency setting on the card configuration profile.
        Parameters:
        currency - The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. This field overrides the existing currency setting on the card configuration profile.
        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**. This field overrides the existing currency setting on the card configuration profile.
        Returns:
        currency The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. This field overrides the existing currency setting on the card configuration profile.

      • 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**. This field overrides the existing currency setting on the card configuration profile.
        Parameters:
        currency - The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. This field overrides the existing currency setting on the card configuration profile.

      • envelope

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

      • getEnvelope

        public String getEnvelope()
        Overrides the envelope design ID defined in the card configuration profile.
        Returns:
        envelope Overrides the envelope design ID defined in the card configuration profile.

      • setEnvelope

        public void setEnvelope​(String envelope)
        Overrides the envelope design ID defined in the card configuration profile.
        Parameters:
        envelope - Overrides the envelope design ID defined in the card configuration profile.

      • insert

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

      • getInsert

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

      • setInsert

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

        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 - 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:
        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 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**.

      • 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 - 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**.

      • logoImageId

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

      • getLogoImageId

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

      • setLogoImageId

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

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

      • getPinMailer

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

      • setPinMailer

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

        public CardConfiguration shipmentMethod​(String shipmentMethod)
        The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
        Parameters:
        shipmentMethod - The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
        Returns:
        the current CardConfiguration instance, allowing for method chaining

      • getShipmentMethod

        public String getShipmentMethod()
        The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
        Returns:
        shipmentMethod The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.

      • setShipmentMethod

        public void setShipmentMethod​(String shipmentMethod)
        The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.
        Parameters:
        shipmentMethod - The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile.

      • includeNullValues

        public CardConfiguration includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • 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

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • 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