Class PaymentInstrumentData


  • public class PaymentInstrumentData
    extends Object
    Data related to the instrument of payment for the transaction. Sent in the result of the payment transaction. For a card, it could also be sent in the `CardAcquisition` response, to be processed by the Sale System.
    • Constructor Detail

      • PaymentInstrumentData

        public PaymentInstrumentData()
    • Method Detail

      • paymentInstrumentType

        public PaymentInstrumentData paymentInstrumentType​(PaymentInstrumentType paymentInstrumentType)
        paymentInstrumentType
        Parameters:
        paymentInstrumentType -
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getPaymentInstrumentType

        public PaymentInstrumentType getPaymentInstrumentType()
        Get paymentInstrumentType
        Returns:
        paymentInstrumentType
      • setPaymentInstrumentType

        public void setPaymentInstrumentType​(PaymentInstrumentType paymentInstrumentType)
        paymentInstrumentType
        Parameters:
        paymentInstrumentType -
      • protectedCardData

        public PaymentInstrumentData protectedCardData​(String protectedCardData)
        Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
        Parameters:
        protectedCardData - Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getProtectedCardData

        public String getProtectedCardData()
        Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
        Returns:
        protectedCardData Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
      • setProtectedCardData

        public void setProtectedCardData​(String protectedCardData)
        Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
        Parameters:
        protectedCardData - Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
      • cardData

        public PaymentInstrumentData cardData​(CardData cardData)
        cardData
        Parameters:
        cardData -
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getCardData

        public CardData getCardData()
        Get cardData
        Returns:
        cardData
      • setCardData

        public void setCardData​(CardData cardData)
        cardData
        Parameters:
        cardData -
      • checkData

        public PaymentInstrumentData checkData​(CheckData checkData)
        checkData
        Parameters:
        checkData -
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getCheckData

        public CheckData getCheckData()
        Get checkData
        Returns:
        checkData
      • setCheckData

        public void setCheckData​(CheckData checkData)
        checkData
        Parameters:
        checkData -
      • mobileData

        public PaymentInstrumentData mobileData​(MobileData mobileData)
        mobileData
        Parameters:
        mobileData -
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getMobileData

        public MobileData getMobileData()
        Get mobileData
        Returns:
        mobileData
      • setMobileData

        public void setMobileData​(MobileData mobileData)
        mobileData
        Parameters:
        mobileData -
      • storedValueAccountID

        public PaymentInstrumentData storedValueAccountID​(StoredValueAccountID storedValueAccountID)
        storedValueAccountID
        Parameters:
        storedValueAccountID -
        Returns:
        the current PaymentInstrumentData instance, allowing for method chaining
      • getStoredValueAccountID

        public StoredValueAccountID getStoredValueAccountID()
        Get storedValueAccountID
        Returns:
        storedValueAccountID
      • setStoredValueAccountID

        public void setStoredValueAccountID​(StoredValueAccountID storedValueAccountID)
        storedValueAccountID
        Parameters:
        storedValueAccountID -
      • includeNullValues

        public PaymentInstrumentData 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 PaymentInstrumentData 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 PaymentInstrumentData fromJson​(String jsonString)
                                              throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of PaymentInstrumentData given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of PaymentInstrumentData
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentInstrumentData
      • toJson

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