Package com.blockchyp.client.dto

Class PaymentLinkStatusResponse

java.lang.Object
com.blockchyp.client.dto.PaymentLinkStatusResponse
All Implemented Interfaces:
IAbstractAcknowledgement
public class PaymentLinkStatusResponse extends Object implements IAbstractAcknowledgement
Models the status of a payment link.

  • Constructor Details

    • PaymentLinkStatusResponse

      public PaymentLinkStatusResponse()

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

    • setLinkCode

      public void setLinkCode(String value)
      Sets the code used to retrieve the payment link.
      Parameters:
      value - the code used to retrieve the payment link.

    • getLinkCode

      public String getLinkCode()
      Gets the code used to retrieve the payment link.
      Returns:
      the code used to retrieve the payment link.

    • setMerchantId

      public void setMerchantId(String value)
      Sets the BlockChyp merchant id associated with a payment link.
      Parameters:
      value - the BlockChyp merchant id associated with a payment link.

    • getMerchantId

      public String getMerchantId()
      Gets the BlockChyp merchant id associated with a payment link.
      Returns:
      the BlockChyp merchant id associated with a payment link.

    • setCustomerId

      public void setCustomerId(String value)
      Sets the customer id associated with a payment link.
      Parameters:
      value - the customer id associated with a payment link.

    • getCustomerId

      public String getCustomerId()
      Gets the customer id associated with a payment link.
      Returns:
      the customer id associated with a payment link.

    • setTransactionRef

      public void setTransactionRef(String value)
      Sets the user's internal reference for any transaction that may occur.
      Parameters:
      value - the user's internal reference for any transaction that may occur.

    • getTransactionRef

      public String getTransactionRef()
      Gets the user's internal reference for any transaction that may occur.
      Returns:
      the user's internal reference for any transaction that may occur.

    • setOrderRef

      public void setOrderRef(String value)
      Sets the user's internal reference for an order.
      Parameters:
      value - the user's internal reference for an order.

    • getOrderRef

      public String getOrderRef()
      Gets the user's internal reference for an order.
      Returns:
      the user's internal reference for an order.

    • setTaxExempt

      public void setTaxExempt(boolean value)
      Sets that the order is tax exempt.
      Parameters:
      value - that the order is tax exempt.

    • isTaxExempt

      public boolean isTaxExempt()
      Gets that the order is tax exempt.
      Returns:
      that the order is tax exempt.

    • setAmount

      public void setAmount(String value)
      Sets that the amount to collect via the payment link.
      Parameters:
      value - that the amount to collect via the payment link.

    • getAmount

      public String getAmount()
      Gets that the amount to collect via the payment link.
      Returns:
      that the amount to collect via the payment link.

    • setTaxAmount

      public void setTaxAmount(String value)
      Sets the sales tax to be collected via the payment link.
      Parameters:
      value - the sales tax to be collected via the payment link.

    • getTaxAmount

      public String getTaxAmount()
      Gets the sales tax to be collected via the payment link.
      Returns:
      the sales tax to be collected via the payment link.

    • setSubject

      public void setSubject(String value)
      Sets subject for email notifications.
      Parameters:
      value - subject for email notifications.

    • getSubject

      public String getSubject()
      Gets subject for email notifications.
      Returns:
      subject for email notifications.

    • setTransactionId

      public void setTransactionId(String value)
      Sets id of the most recent transaction associated with the link.
      Parameters:
      value - id of the most recent transaction associated with the link.

    • getTransactionId

      public String getTransactionId()
      Gets id of the most recent transaction associated with the link.
      Returns:
      id of the most recent transaction associated with the link.

    • setDescription

      public void setDescription(String value)
      Sets description associated with the payment link.
      Parameters:
      value - description associated with the payment link.

    • getDescription

      public String getDescription()
      Gets description associated with the payment link.
      Returns:
      description associated with the payment link.

    • setExpiration

      public void setExpiration(Date value)
      Sets date and time the link will expire.
      Parameters:
      value - date and time the link will expire.

    • getExpiration

      public Date getExpiration()
      Gets date and time the link will expire.
      Returns:
      date and time the link will expire.

    • setDateCreated

      public void setDateCreated(Date value)
      Sets date and time the link was created.
      Parameters:
      value - date and time the link was created.

    • getDateCreated

      public Date getDateCreated()
      Gets date and time the link was created.
      Returns:
      date and time the link was created.

    • setTransactionDetails

      public void setTransactionDetails(TransactionDisplayTransaction value)
      Sets line item level data if provided.
      Parameters:
      value - line item level data if provided.

    • getTransactionDetails

      public TransactionDisplayTransaction getTransactionDetails()
      Gets line item level data if provided.
      Returns:
      line item level data if provided.

    • setStatus

      public void setStatus(String value)
      Sets the current status of the payment link.
      Parameters:
      value - the current status of the payment link.

    • getStatus

      public String getStatus()
      Gets the current status of the payment link.
      Returns:
      the current status of the payment link.

    • setTcAlias

      public void setTcAlias(String value)
      Sets alias for any terms and conditions language associated with the link.
      Parameters:
      value - alias for any terms and conditions language associated with the link.

    • getTcAlias

      public String getTcAlias()
      Gets alias for any terms and conditions language associated with the link.
      Returns:
      alias for any terms and conditions language associated with the link.

    • setTcName

      public void setTcName(String value)
      Sets name of any terms and conditions agreements associated with the payment link.
      Parameters:
      value - name of any terms and conditions agreements associated with the payment link.

    • getTcName

      public String getTcName()
      Gets name of any terms and conditions agreements associated with the payment link.
      Returns:
      name of any terms and conditions agreements associated with the payment link.

    • setTcContent

      public void setTcContent(String value)
      Sets full text of any terms and conditions language associated with the agreement.
      Parameters:
      value - full text of any terms and conditions language associated with the agreement.

    • getTcContent

      public String getTcContent()
      Gets full text of any terms and conditions language associated with the agreement.
      Returns:
      full text of any terms and conditions language associated with the agreement.

    • setCashierFacing

      public void setCashierFacing(boolean value)
      Sets that the link is intended for internal use by the merchant.
      Parameters:
      value - that the link is intended for internal use by the merchant.

    • isCashierFacing

      public boolean isCashierFacing()
      Gets that the link is intended for internal use by the merchant.
      Returns:
      that the link is intended for internal use by the merchant.

    • setEnroll

      public void setEnroll(boolean value)
      Sets that the payment method should be enrolled in the token vault.
      Parameters:
      value - that the payment method should be enrolled in the token vault.

    • isEnroll

      public boolean isEnroll()
      Gets that the payment method should be enrolled in the token vault.
      Returns:
      that the payment method should be enrolled in the token vault.

    • setEnrollOnly

      public void setEnrollOnly(boolean value)
      Sets that the link should only be used for enrollment in the token vault without any underlying payment transaction.
      Parameters:
      value - that the link should only be used for enrollment in the token vault without any underlying payment transaction.

    • isEnrollOnly

      public boolean isEnrollOnly()
      Gets that the link should only be used for enrollment in the token vault without any underlying payment transaction.
      Returns:
      that the link should only be used for enrollment in the token vault without any underlying payment transaction.

    • setLastTransaction

      public void setLastTransaction(AuthorizationResponse value)
      Sets returns details about the last transaction status.
      Parameters:
      value - returns details about the last transaction status.

    • getLastTransaction

      public AuthorizationResponse getLastTransaction()
      Gets returns details about the last transaction status.
      Returns:
      returns details about the last transaction status.

    • setTransactionHistory

      public void setTransactionHistory(Collection<AuthorizationResponse> value)
      Sets returns a list of transactions associated with the link, including any declines.
      Parameters:
      value - returns a list of transactions associated with the link, including any declines.

    • getTransactionHistory

      public Collection<AuthorizationResponse> getTransactionHistory()
      Gets returns a list of transactions associated with the link, including any declines.
      Returns:
      returns a list of transactions associated with the link, including any declines.

    • addTransactionHistory

      public void addTransactionHistory(AuthorizationResponse value)
      Adds a returns a list of transactions associated with the link, including any declines.
      Parameters:
      value - returns a list of transactions associated with the link, including any declines.