Class CheckData


  • public class CheckData
    extends Object
    Information related to the paper check used for the transaction. Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment.
    • Constructor Detail

      • CheckData

        public CheckData()
    • Method Detail

      • bankID

        public CheckData bankID​(String bankID)
        Identification of the bank. Mandatory if TrackData absent.
        Parameters:
        bankID - Identification of the bank. Mandatory if TrackData absent.
        Returns:
        the current CheckData instance, allowing for method chaining
      • getBankID

        public String getBankID()
        Identification of the bank. Mandatory if TrackData absent.
        Returns:
        bankID Identification of the bank. Mandatory if TrackData absent.
      • setBankID

        public void setBankID​(String bankID)
        Identification of the bank. Mandatory if TrackData absent.
        Parameters:
        bankID - Identification of the bank. Mandatory if TrackData absent.
      • accountNumber

        public CheckData accountNumber​(String accountNumber)
        Identification of the customer account. Mandatory if TrackData absent.
        Parameters:
        accountNumber - Identification of the customer account. Mandatory if TrackData absent.
        Returns:
        the current CheckData instance, allowing for method chaining
      • getAccountNumber

        public String getAccountNumber()
        Identification of the customer account. Mandatory if TrackData absent.
        Returns:
        accountNumber Identification of the customer account. Mandatory if TrackData absent.
      • setAccountNumber

        public void setAccountNumber​(String accountNumber)
        Identification of the customer account. Mandatory if TrackData absent.
        Parameters:
        accountNumber - Identification of the customer account. Mandatory if TrackData absent.
      • checkNumber

        public CheckData checkNumber​(String checkNumber)
        Identification of the bank check. Mandatory if TrackData absent.
        Parameters:
        checkNumber - Identification of the bank check. Mandatory if TrackData absent.
        Returns:
        the current CheckData instance, allowing for method chaining
      • getCheckNumber

        public String getCheckNumber()
        Identification of the bank check. Mandatory if TrackData absent.
        Returns:
        checkNumber Identification of the bank check. Mandatory if TrackData absent.
      • setCheckNumber

        public void setCheckNumber​(String checkNumber)
        Identification of the bank check. Mandatory if TrackData absent.
        Parameters:
        checkNumber - Identification of the bank check. Mandatory if TrackData absent.
      • trackData

        public CheckData trackData​(TrackData trackData)
        trackData
        Parameters:
        trackData -
        Returns:
        the current CheckData instance, allowing for method chaining
      • getTrackData

        public TrackData getTrackData()
        Get trackData
        Returns:
        trackData
      • setTrackData

        public void setTrackData​(TrackData trackData)
        trackData
        Parameters:
        trackData -
      • checkCardNumber

        public CheckData checkCardNumber​(String checkCardNumber)
        Check guarantee card number. If provided by the customer.
        Parameters:
        checkCardNumber - Check guarantee card number. If provided by the customer.
        Returns:
        the current CheckData instance, allowing for method chaining
      • getCheckCardNumber

        public String getCheckCardNumber()
        Check guarantee card number. If provided by the customer.
        Returns:
        checkCardNumber Check guarantee card number. If provided by the customer.
      • setCheckCardNumber

        public void setCheckCardNumber​(String checkCardNumber)
        Check guarantee card number. If provided by the customer.
        Parameters:
        checkCardNumber - Check guarantee card number. If provided by the customer.
      • typeCode

        public CheckData typeCode​(TypeCode typeCode)
        typeCode
        Parameters:
        typeCode -
        Returns:
        the current CheckData instance, allowing for method chaining
      • getTypeCode

        public TypeCode getTypeCode()
        Get typeCode
        Returns:
        typeCode
      • setTypeCode

        public void setTypeCode​(TypeCode typeCode)
        typeCode
        Parameters:
        typeCode -
      • country

        public CheckData country​(String country)
        Country of the bank check. Absent if country of the Sale system.
        Parameters:
        country - Country of the bank check. Absent if country of the Sale system.
        Returns:
        the current CheckData instance, allowing for method chaining
      • getCountry

        public String getCountry()
        Country of the bank check. Absent if country of the Sale system.
        Returns:
        country Country of the bank check. Absent if country of the Sale system.
      • setCountry

        public void setCountry​(String country)
        Country of the bank check. Absent if country of the Sale system.
        Parameters:
        country - Country of the bank check. Absent if country of the Sale system.
      • includeNullValues

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

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