Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class MerchantPayableBreakdown

java.lang.Object
com.broadleafcommerce.paypal.micro.gateway.domain.orders.MerchantPayableBreakdown
All Implemented Interfaces:
Serializable
public class MerchantPayableBreakdown extends Object implements Serializable
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • MerchantPayableBreakdown

      public MerchantPayableBreakdown()

  • Method Details

    • setGrossAmount

      public void setGrossAmount(Money grossAmount)
      The amount that the payee refunded to the payer.

    • setNetAmount

      public void setNetAmount(Money netAmount)
      The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as "gross_amount" minus "paypal_fee" minus "platform_fees".

    • setNetAmountBreakdown

      public void setNetAmountBreakdown(List<NetAmountBreakdownItem> netAmountBreakdown)
      An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds.

    • setNetAmountInReceivableCurrency

      public void setNetAmountInReceivableCurrency(Money netAmountInReceivableCurrency)
      The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

    • setPaypalFee

      public void setPaypalFee(Money paypalFee)
      The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.

    • setPaypalFeeInReceivableCurrency

      public void setPaypalFeeInReceivableCurrency(Money paypalFeeInReceivableCurrency)
      The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

    • setPlatformFee

      public void setPlatformFee(PlatformFee platformFee)
      An array of platform or partner fees, commissions, or brokerage fees for the refund.

    • setTotalRefundedAmount

      public void setTotalRefundedAmount(Money totalRefundedAmount)
      The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the "gross_amount" is $30 for this refund and the "total_refunded_amount" is $50.

    • getGrossAmount

      public Money getGrossAmount()
      The amount that the payee refunded to the payer.

    • getNetAmount

      public Money getNetAmount()
      The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as "gross_amount" minus "paypal_fee" minus "platform_fees".

    • getNetAmountBreakdown

      public List<NetAmountBreakdownItem> getNetAmountBreakdown()
      An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds.

    • getNetAmountInReceivableCurrency

      public Money getNetAmountInReceivableCurrency()
      The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

    • getPaypalFee

      public Money getPaypalFee()
      The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.

    • getPaypalFeeInReceivableCurrency

      public Money getPaypalFeeInReceivableCurrency()
      The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

    • getPlatformFee

      public PlatformFee getPlatformFee()
      An array of platform or partner fees, commissions, or brokerage fees for the refund.

    • getTotalRefundedAmount

      public Money getTotalRefundedAmount()
      The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the "gross_amount" is $30 for this refund and the "total_refunded_amount" is $50.