Package com.blockchyp.client.dto

Class PartnerCommissionBreakdownResponse

java.lang.Object
com.blockchyp.client.dto.PartnerCommissionBreakdownResponse
All Implemented Interfaces:
IAbstractAcknowledgement
public class PartnerCommissionBreakdownResponse extends Object implements IAbstractAcknowledgement
Models detailed information about how partner commissions were calculated for a statement.

  • Constructor Details

    • PartnerCommissionBreakdownResponse

      public PartnerCommissionBreakdownResponse()

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

    • setInvoiceId

      public void setInvoiceId(String value)
      Sets the invoice (statement id) for which the commissions were calculated.
      Parameters:
      value - the invoice (statement id) for which the commissions were calculated.

    • getInvoiceId

      public String getInvoiceId()
      Gets the invoice (statement id) for which the commissions were calculated.
      Returns:
      the invoice (statement id) for which the commissions were calculated.

    • setPartnerName

      public void setPartnerName(String value)
      Sets the partner name.
      Parameters:
      value - the partner name.

    • getPartnerName

      public String getPartnerName()
      Gets the partner name.
      Returns:
      the partner name.

    • setPartnerStatementId

      public void setPartnerStatementId(String value)
      Sets the partner statement id.
      Parameters:
      value - the partner statement id.

    • getPartnerStatementId

      public String getPartnerStatementId()
      Gets the partner statement id.
      Returns:
      the partner statement id.

    • setPartnerStatementDate

      public void setPartnerStatementDate(Date value)
      Sets the partner statement date.
      Parameters:
      value - the partner statement date.

    • getPartnerStatementDate

      public Date getPartnerStatementDate()
      Gets the partner statement date.
      Returns:
      the partner statement date.

    • setMerchantId

      public void setMerchantId(String value)
      Sets the merchant id.
      Parameters:
      value - the merchant id.

    • getMerchantId

      public String getMerchantId()
      Gets the merchant id.
      Returns:
      the merchant id.

    • setMerchantCompanyName

      public void setMerchantCompanyName(String value)
      Sets the merchant's corporate name.
      Parameters:
      value - the merchant's corporate name.

    • getMerchantCompanyName

      public String getMerchantCompanyName()
      Gets the merchant's corporate name.
      Returns:
      the merchant's corporate name.

    • setMerchantDbaName

      public void setMerchantDbaName(String value)
      Sets the merchant's dba name.
      Parameters:
      value - the merchant's dba name.

    • getMerchantDbaName

      public String getMerchantDbaName()
      Gets the merchant's dba name.
      Returns:
      the merchant's dba name.

    • setGrandTotal

      public void setGrandTotal(float value)
      Sets the grand total.
      Parameters:
      value - the grand total.

    • getGrandTotal

      public float getGrandTotal()
      Gets the grand total.
      Returns:
      the grand total.

    • setGrandTotalFormatted

      public void setGrandTotalFormatted(String value)
      Sets the currency formatted grand total.
      Parameters:
      value - the currency formatted grand total.

    • getGrandTotalFormatted

      public String getGrandTotalFormatted()
      Gets the currency formatted grand total.
      Returns:
      the currency formatted grand total.

    • setTotalFees

      public void setTotalFees(float value)
      Sets the total fees.
      Parameters:
      value - the total fees.

    • getTotalFees

      public float getTotalFees()
      Gets the total fees.
      Returns:
      the total fees.

    • setTotalFeesFormatted

      public void setTotalFeesFormatted(String value)
      Sets the currency formatted total fees.
      Parameters:
      value - the currency formatted total fees.

    • getTotalFeesFormatted

      public String getTotalFeesFormatted()
      Gets the currency formatted total fees.
      Returns:
      the currency formatted total fees.

    • setTotalDue

      public void setTotalDue(float value)
      Sets the total due the partner for this merchant statement.
      Parameters:
      value - the total due the partner for this merchant statement.

    • getTotalDue

      public float getTotalDue()
      Gets the total due the partner for this merchant statement.
      Returns:
      the total due the partner for this merchant statement.

    • setTotalDueFormatted

      public void setTotalDueFormatted(String value)
      Sets the currency formatted total due the partner for this merchant statement.
      Parameters:
      value - the currency formatted total due the partner for this merchant statement.

    • getTotalDueFormatted

      public String getTotalDueFormatted()
      Gets the currency formatted total due the partner for this merchant statement.
      Returns:
      the currency formatted total due the partner for this merchant statement.

    • setTotalVolume

      public void setTotalVolume(float value)
      Sets the total volume during the statement period.
      Parameters:
      value - the total volume during the statement period.

    • getTotalVolume

      public float getTotalVolume()
      Gets the total volume during the statement period.
      Returns:
      the total volume during the statement period.

    • setTotalVolumeFormatted

      public void setTotalVolumeFormatted(String value)
      Sets the currency formatted total volume during the statement period.
      Parameters:
      value - the currency formatted total volume during the statement period.

    • getTotalVolumeFormatted

      public String getTotalVolumeFormatted()
      Gets the currency formatted total volume during the statement period.
      Returns:
      the currency formatted total volume during the statement period.

    • setTotalTransactions

      public void setTotalTransactions(int value)
      Sets the total number of transactions processed during the statement period.
      Parameters:
      value - the total number of transactions processed during the statement period.

    • getTotalTransactions

      public int getTotalTransactions()
      Gets the total number of transactions processed during the statement period.
      Returns:
      the total number of transactions processed during the statement period.

    • setPartnerResidual

      public void setPartnerResidual(float value)
      Sets the residual earned by the partner.
      Parameters:
      value - the residual earned by the partner.

    • getPartnerResidual

      public float getPartnerResidual()
      Gets the residual earned by the partner.
      Returns:
      the residual earned by the partner.

    • setPartnerResidualFormatted

      public void setPartnerResidualFormatted(String value)
      Sets the currency formatted residual earned by the partner.
      Parameters:
      value - the currency formatted residual earned by the partner.

    • getPartnerResidualFormatted

      public String getPartnerResidualFormatted()
      Gets the currency formatted residual earned by the partner.
      Returns:
      the currency formatted residual earned by the partner.

    • setInterchange

      public void setInterchange(float value)
      Sets the total interchange charged during the statement period.
      Parameters:
      value - the total interchange charged during the statement period.

    • getInterchange

      public float getInterchange()
      Gets the total interchange charged during the statement period.
      Returns:
      the total interchange charged during the statement period.

    • setInterchangeFormatted

      public void setInterchangeFormatted(String value)
      Sets the currency formatted total interchange charged during the statement period.
      Parameters:
      value - the currency formatted total interchange charged during the statement period.

    • getInterchangeFormatted

      public String getInterchangeFormatted()
      Gets the currency formatted total interchange charged during the statement period.
      Returns:
      the currency formatted total interchange charged during the statement period.

    • setAssessments

      public void setAssessments(float value)
      Sets the total assessments charged during the statement period.
      Parameters:
      value - the total assessments charged during the statement period.

    • getAssessments

      public float getAssessments()
      Gets the total assessments charged during the statement period.
      Returns:
      the total assessments charged during the statement period.

    • setAssessmentsFormatted

      public void setAssessmentsFormatted(String value)
      Sets the currency formatted assessments charged during the statement period.
      Parameters:
      value - the currency formatted assessments charged during the statement period.

    • getAssessmentsFormatted

      public String getAssessmentsFormatted()
      Gets the currency formatted assessments charged during the statement period.
      Returns:
      the currency formatted assessments charged during the statement period.

    • setTotalPassthrough

      public void setTotalPassthrough(float value)
      Sets the total of passthrough costs.
      Parameters:
      value - the total of passthrough costs.

    • getTotalPassthrough

      public float getTotalPassthrough()
      Gets the total of passthrough costs.
      Returns:
      the total of passthrough costs.

    • setTotalPassthroughFormatted

      public void setTotalPassthroughFormatted(String value)
      Sets the currency formatted total of passthrough costs.
      Parameters:
      value - the currency formatted total of passthrough costs.

    • getTotalPassthroughFormatted

      public String getTotalPassthroughFormatted()
      Gets the currency formatted total of passthrough costs.
      Returns:
      the currency formatted total of passthrough costs.

    • setTotalNonPassthrough

      public void setTotalNonPassthrough(float value)
      Sets the total of non passthrough costs.
      Parameters:
      value - the total of non passthrough costs.

    • getTotalNonPassthrough

      public float getTotalNonPassthrough()
      Gets the total of non passthrough costs.
      Returns:
      the total of non passthrough costs.

    • setTotalNonPassthroughFormatted

      public void setTotalNonPassthroughFormatted(String value)
      Sets the currency formatted total of non passthrough costs.
      Parameters:
      value - the currency formatted total of non passthrough costs.

    • getTotalNonPassthroughFormatted

      public String getTotalNonPassthroughFormatted()
      Gets the currency formatted total of non passthrough costs.
      Returns:
      the currency formatted total of non passthrough costs.

    • setTotalCardBrandFees

      public void setTotalCardBrandFees(float value)
      Sets the total of all card brand fees.
      Parameters:
      value - the total of all card brand fees.

    • getTotalCardBrandFees

      public float getTotalCardBrandFees()
      Gets the total of all card brand fees.
      Returns:
      the total of all card brand fees.

    • setTotalCardBrandFeesFormatted

      public void setTotalCardBrandFeesFormatted(String value)
      Sets the currency formatted total of all card brand fees.
      Parameters:
      value - the currency formatted total of all card brand fees.

    • getTotalCardBrandFeesFormatted

      public String getTotalCardBrandFeesFormatted()
      Gets the currency formatted total of all card brand fees.
      Returns:
      the currency formatted total of all card brand fees.

    • setTotalBuyRate

      public void setTotalBuyRate(float value)
      Sets the total buy rate.
      Parameters:
      value - the total buy rate.

    • getTotalBuyRate

      public float getTotalBuyRate()
      Gets the total buy rate.
      Returns:
      the total buy rate.

    • setTotalBuyRateFormatted

      public void setTotalBuyRateFormatted(String value)
      Sets the currency formatted total buy rate.
      Parameters:
      value - the currency formatted total buy rate.

    • getTotalBuyRateFormatted

      public String getTotalBuyRateFormatted()
      Gets the currency formatted total buy rate.
      Returns:
      the currency formatted total buy rate.

    • setBuyRateBeforePassthrough

      public void setBuyRateBeforePassthrough(float value)
      Sets the total buy rate before passthrough costs.
      Parameters:
      value - the total buy rate before passthrough costs.

    • getBuyRateBeforePassthrough

      public float getBuyRateBeforePassthrough()
      Gets the total buy rate before passthrough costs.
      Returns:
      the total buy rate before passthrough costs.

    • setBuyRateBeforePassthroughFormatted

      public void setBuyRateBeforePassthroughFormatted(String value)
      Sets the currency formatted total buy rate before passthrough costs.
      Parameters:
      value - the currency formatted total buy rate before passthrough costs.

    • getBuyRateBeforePassthroughFormatted

      public String getBuyRateBeforePassthroughFormatted()
      Gets the currency formatted total buy rate before passthrough costs.
      Returns:
      the currency formatted total buy rate before passthrough costs.

    • setNetMarkup

      public void setNetMarkup(float value)
      Sets the net markup split between BlockChyp and the partner.
      Parameters:
      value - the net markup split between BlockChyp and the partner.

    • getNetMarkup

      public float getNetMarkup()
      Gets the net markup split between BlockChyp and the partner.
      Returns:
      the net markup split between BlockChyp and the partner.

    • setNetMarkupFormatted

      public void setNetMarkupFormatted(String value)
      Sets the currency formatted net markup split between BlockChyp and the partner.
      Parameters:
      value - the currency formatted net markup split between BlockChyp and the partner.

    • getNetMarkupFormatted

      public String getNetMarkupFormatted()
      Gets the currency formatted net markup split between BlockChyp and the partner.
      Returns:
      the currency formatted net markup split between BlockChyp and the partner.

    • setPartnerNonPassthroughShare

      public void setPartnerNonPassthroughShare(float value)
      Sets the partner's total share of non passthrough hard costs.
      Parameters:
      value - the partner's total share of non passthrough hard costs.

    • getPartnerNonPassthroughShare

      public float getPartnerNonPassthroughShare()
      Gets the partner's total share of non passthrough hard costs.
      Returns:
      the partner's total share of non passthrough hard costs.

    • setPartnerNonPassthroughShareFormatted

      public void setPartnerNonPassthroughShareFormatted(String value)
      Sets the currency formatted partner's total share of non passthrough hard costs.
      Parameters:
      value - the currency formatted partner's total share of non passthrough hard costs.

    • getPartnerNonPassthroughShareFormatted

      public String getPartnerNonPassthroughShareFormatted()
      Gets the currency formatted partner's total share of non passthrough hard costs.
      Returns:
      the currency formatted partner's total share of non passthrough hard costs.

    • setChargebackFees

      public void setChargebackFees(float value)
      Sets the total of chargeback fees assessed during the statement period.
      Parameters:
      value - the total of chargeback fees assessed during the statement period.

    • getChargebackFees

      public float getChargebackFees()
      Gets the total of chargeback fees assessed during the statement period.
      Returns:
      the total of chargeback fees assessed during the statement period.

    • setChargebackFeesFormatted

      public void setChargebackFeesFormatted(String value)
      Sets the currency formatted total of chargeback fees assessed during the statement period.
      Parameters:
      value - the currency formatted total of chargeback fees assessed during the statement period.

    • getChargebackFeesFormatted

      public String getChargebackFeesFormatted()
      Gets the currency formatted total of chargeback fees assessed during the statement period.
      Returns:
      the currency formatted total of chargeback fees assessed during the statement period.

    • setChargebackCount

      public void setChargebackCount(int value)
      Sets the total number of chargebacks during the period.
      Parameters:
      value - the total number of chargebacks during the period.

    • getChargebackCount

      public int getChargebackCount()
      Gets the total number of chargebacks during the period.
      Returns:
      the total number of chargebacks during the period.

    • setPartnerPercentage

      public void setPartnerPercentage(float value)
      Sets the partner's share of markup.
      Parameters:
      value - the partner's share of markup.

    • getPartnerPercentage

      public float getPartnerPercentage()
      Gets the partner's share of markup.
      Returns:
      the partner's share of markup.

    • setPartnerPercentageFormatted

      public void setPartnerPercentageFormatted(String value)
      Sets the currency formatted partner's share of markup.
      Parameters:
      value - the currency formatted partner's share of markup.

    • getPartnerPercentageFormatted

      public String getPartnerPercentageFormatted()
      Gets the currency formatted partner's share of markup.
      Returns:
      the currency formatted partner's share of markup.

    • setBuyRateLineItems

      public void setBuyRateLineItems(Collection<BuyRateLineItem> value)
      Sets the list of line items documenting how the total buy rate was calculated.
      Parameters:
      value - the list of line items documenting how the total buy rate was calculated.

    • getBuyRateLineItems

      public Collection<BuyRateLineItem> getBuyRateLineItems()
      Gets the list of line items documenting how the total buy rate was calculated.
      Returns:
      the list of line items documenting how the total buy rate was calculated.

    • setRevenueDetails

      public void setRevenueDetails(Collection<AggregateBillingLineItem> value)
      Sets the list of detail lines describing how revenue was calculated and collected by the sponsor bank.
      Parameters:
      value - the list of detail lines describing how revenue was calculated and collected by the sponsor bank.

    • getRevenueDetails

      public Collection<AggregateBillingLineItem> getRevenueDetails()
      Gets the list of detail lines describing how revenue was calculated and collected by the sponsor bank.
      Returns:
      the list of detail lines describing how revenue was calculated and collected by the sponsor bank.

    • setCardBrandCostDetails

      public void setCardBrandCostDetails(Collection<AggregateBillingLineItem> value)
      Sets the nested list of costs levied by the card brands, grouped by card brand and type.
      Parameters:
      value - the nested list of costs levied by the card brands, grouped by card brand and type.

    • getCardBrandCostDetails

      public Collection<AggregateBillingLineItem> getCardBrandCostDetails()
      Gets the nested list of costs levied by the card brands, grouped by card brand and type.
      Returns:
      the nested list of costs levied by the card brands, grouped by card brand and type.

    • addBuyRateLineItem

      public void addBuyRateLineItem(BuyRateLineItem value)
      Adds a the list of line items documenting how the total buy rate was calculated.
      Parameters:
      value - the list of line items documenting how the total buy rate was calculated.

    • addRevenueDetail

      public void addRevenueDetail(AggregateBillingLineItem value)
      Adds a the list of detail lines describing how revenue was calculated and collected by the sponsor bank.
      Parameters:
      value - the list of detail lines describing how revenue was calculated and collected by the sponsor bank.

    • addCardBrandCostDetail

      public void addCardBrandCostDetail(AggregateBillingLineItem value)
      Adds a the nested list of costs levied by the card brands, grouped by card brand and type.
      Parameters:
      value - the nested list of costs levied by the card brands, grouped by card brand and type.