Package com.blockchyp.client.dto

Class CardMetadataResponse

java.lang.Object
com.blockchyp.client.dto.CardMetadataResponse
All Implemented Interfaces:
IAbstractAcknowledgement, IPaymentMethodResponse
public class CardMetadataResponse extends Object implements IAbstractAcknowledgement, IPaymentMethodResponse
The response to a card metadata request.

  • Constructor Details

    • CardMetadataResponse

      public CardMetadataResponse()

  • Method Details

    • setSuccess

      public void setSuccess(boolean value)
      Sets whether or not the request succeeded.
      Parameters:
      value - whether or not the request succeeded.

    • isSuccess

      public boolean isSuccess()
      Gets whether or not the request succeeded.
      Specified by:
      isSuccess in interface IAbstractAcknowledgement
      Returns:
      whether or not the request succeeded.

    • setError

      public void setError(String value)
      Sets the error, if an error occurred.
      Parameters:
      value - the error, if an error occurred.

    • getError

      public String getError()
      Gets the error, if an error occurred.
      Specified by:
      getError in interface IAbstractAcknowledgement
      Returns:
      the error, if an error occurred.

    • setResponseDescription

      public void setResponseDescription(String value)
      Sets a narrative description of the transaction result.
      Parameters:
      value - a narrative description of the transaction result.

    • getResponseDescription

      public String getResponseDescription()
      Gets a narrative description of the transaction result.
      Specified by:
      getResponseDescription in interface IAbstractAcknowledgement
      Returns:
      a narrative description of the transaction result.

    • setToken

      public void setToken(String value)
      Sets the payment token, if the payment was enrolled in the vault.
      Parameters:
      value - the payment token, if the payment was enrolled in the vault.

    • getToken

      public String getToken()
      Gets the payment token, if the payment was enrolled in the vault.
      Specified by:
      getToken in interface IPaymentMethodResponse
      Returns:
      the payment token, if the payment was enrolled in the vault.

    • setEntryMethod

      public void setEntryMethod(String value)
      Sets the entry method for the transaction (CHIP, MSR, KEYED, etc).
      Parameters:
      value - the entry method for the transaction (CHIP, MSR, KEYED, etc).

    • getEntryMethod

      public String getEntryMethod()
      Gets the entry method for the transaction (CHIP, MSR, KEYED, etc).
      Specified by:
      getEntryMethod in interface IPaymentMethodResponse
      Returns:
      the entry method for the transaction (CHIP, MSR, KEYED, etc).

    • setPaymentType

      public void setPaymentType(String value)
      Sets the card brand (VISA, MC, AMEX, DEBIT, etc).
      Parameters:
      value - the card brand (VISA, MC, AMEX, DEBIT, etc).

    • getPaymentType

      public String getPaymentType()
      Gets the card brand (VISA, MC, AMEX, DEBIT, etc).
      Specified by:
      getPaymentType in interface IPaymentMethodResponse
      Returns:
      the card brand (VISA, MC, AMEX, DEBIT, etc).

    • setNetwork

      public void setNetwork(String value)
      Sets provides network level detail on how a transaction was routed, especially for debit transactions.
      Parameters:
      value - provides network level detail on how a transaction was routed, especially for debit transactions.

    • getNetwork

      public String getNetwork()
      Gets provides network level detail on how a transaction was routed, especially for debit transactions.
      Specified by:
      getNetwork in interface IPaymentMethodResponse
      Returns:
      provides network level detail on how a transaction was routed, especially for debit transactions.

    • setLogo

      public void setLogo(String value)
      Sets identifies the card association based on bin number.
      Parameters:
      value - identifies the card association based on bin number. Used primarily used to indicate the major logo on a card, even when debit transactions are routed on a different network.

    • getLogo

      public String getLogo()
      Gets identifies the card association based on bin number.
      Specified by:
      getLogo in interface IPaymentMethodResponse
      Returns:
      identifies the card association based on bin number. Used primarily used to indicate the major logo on a card, even when debit transactions are routed on a different network.

    • setMaskedPan

      public void setMaskedPan(String value)
      Sets the masked primary account number.
      Parameters:
      value - the masked primary account number.

    • getMaskedPan

      public String getMaskedPan()
      Gets the masked primary account number.
      Specified by:
      getMaskedPan in interface IPaymentMethodResponse
      Returns:
      the masked primary account number.

    • setPublicKey

      public void setPublicKey(String value)
      Sets the BlockChyp public key if the user presented a BlockChyp payment card.
      Parameters:
      value - the BlockChyp public key if the user presented a BlockChyp payment card.

    • getPublicKey

      public String getPublicKey()
      Gets the BlockChyp public key if the user presented a BlockChyp payment card.
      Specified by:
      getPublicKey in interface IPaymentMethodResponse
      Returns:
      the BlockChyp public key if the user presented a BlockChyp payment card.

    • setScopeAlert

      public void setScopeAlert(boolean value)
      Sets that the transaction did something that would put the system in PCI scope.
      Parameters:
      value - that the transaction did something that would put the system in PCI scope.

    • isScopeAlert

      public boolean isScopeAlert()
      Gets that the transaction did something that would put the system in PCI scope.
      Specified by:
      isScopeAlert in interface IPaymentMethodResponse
      Returns:
      that the transaction did something that would put the system in PCI scope.

    • setCardHolder

      public void setCardHolder(String value)
      Sets the cardholder name.
      Parameters:
      value - the cardholder name.

    • getCardHolder

      public String getCardHolder()
      Gets the cardholder name.
      Specified by:
      getCardHolder in interface IPaymentMethodResponse
      Returns:
      the cardholder name.

    • setExpMonth

      public void setExpMonth(String value)
      Sets the card expiration month in MM format.
      Parameters:
      value - the card expiration month in MM format.

    • getExpMonth

      public String getExpMonth()
      Gets the card expiration month in MM format.
      Specified by:
      getExpMonth in interface IPaymentMethodResponse
      Returns:
      the card expiration month in MM format.

    • setExpYear

      public void setExpYear(String value)
      Sets the card expiration year in YY format.
      Parameters:
      value - the card expiration year in YY format.

    • getExpYear

      public String getExpYear()
      Gets the card expiration year in YY format.
      Specified by:
      getExpYear in interface IPaymentMethodResponse
      Returns:
      the card expiration year in YY format.

    • setPostalCode

      public void setPostalCode(String value)
      Sets the card postal code.
      Parameters:
      value - the card postal code.

    • getPostalCode

      public String getPostalCode()
      Gets the card postal code.
      Specified by:
      getPostalCode in interface IPaymentMethodResponse
      Returns:
      the card postal code.

    • setAddress

      public void setAddress(String value)
      Sets the card address.
      Parameters:
      value - the card address.

    • getAddress

      public String getAddress()
      Gets the card address.
      Specified by:
      getAddress in interface IPaymentMethodResponse
      Returns:
      the card address.

    • setCountry

      public void setCountry(String value)
      Sets the card country.
      Parameters:
      value - the card country.

    • getCountry

      public String getCountry()
      Gets the card country.
      Specified by:
      getCountry in interface IPaymentMethodResponse
      Returns:
      the card country.

    • setAvsResponse

      public void setAvsResponse(AvsResponse value)
      Sets address verification results if address information was submitted.
      Parameters:
      value - address verification results if address information was submitted.

    • getAvsResponse

      public AvsResponse getAvsResponse()
      Gets address verification results if address information was submitted.
      Specified by:
      getAvsResponse in interface IPaymentMethodResponse
      Returns:
      address verification results if address information was submitted.

    • setCvvResponse

      public void setCvvResponse(String value)
      Sets the CVV verification result if CVV was submitted.
      Parameters:
      value - the CVV verification result if CVV was submitted.

    • getCvvResponse

      public String getCvvResponse()
      Gets the CVV verification result if CVV was submitted.
      Specified by:
      getCvvResponse in interface IPaymentMethodResponse
      Returns:
      the CVV verification result if CVV was submitted.

    • setReceiptSuggestions

      public void setReceiptSuggestions(ReceiptSuggestions value)
      Sets suggested receipt fields.
      Parameters:
      value - suggested receipt fields.

    • getReceiptSuggestions

      public ReceiptSuggestions getReceiptSuggestions()
      Gets suggested receipt fields.
      Specified by:
      getReceiptSuggestions in interface IPaymentMethodResponse
      Returns:
      suggested receipt fields.

    • setCustomer

      public void setCustomer(Customer value)
      Sets customer data, if any.
      Parameters:
      value - customer data, if any. Preserved for reverse compatibility.

    • getCustomer

      public Customer getCustomer()
      Gets customer data, if any.
      Specified by:
      getCustomer in interface IPaymentMethodResponse
      Returns:
      customer data, if any. Preserved for reverse compatibility.

    • setCustomers

      public void setCustomers(Collection<Customer> value)
      Sets customer data, if any.
      Parameters:
      value - customer data, if any.

    • getCustomers

      public Collection<Customer> getCustomers()
      Gets customer data, if any.
      Specified by:
      getCustomers in interface IPaymentMethodResponse
      Returns:
      customer data, if any.

    • setCardMetadata

      public void setCardMetadata(CardMetadata value)
      Sets details about a payment card derived from its BIN/IIN.
      Parameters:
      value - details about a payment card derived from its BIN/IIN.

    • getCardMetadata

      public CardMetadata getCardMetadata()
      Gets details about a payment card derived from its BIN/IIN.
      Returns:
      details about a payment card derived from its BIN/IIN.

    • addCustomer

      public void addCustomer(Customer value)
      Adds a customer data, if any.
      Parameters:
      value - customer data, if any.