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

Class RefundRequest

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

  • Constructor Details

    • RefundRequest

      public RefundRequest()

  • Method Details

    • setAmount

      public void setAmount(Money amount)
      The amount to refund. To refund a portion of the captured amount, specify an amount. If amount is not specified, an amount equal to "captured amount - previous refunds" is refunded. The amount must be a positive number and in the same currency as the one in which the payment was captured.

    • setInvoiceId

      public void setInvoiceId(String invoiceId)
      The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

    • setNoteToPayer

      public void setNoteToPayer(String noteToPayer)
      The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

    • setPaymentInstruction

      public void setPaymentInstruction(PaymentInstruction paymentInstruction)
      Any additional refund instructions to be set during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.

    • getAmount

      public Money getAmount()
      The amount to refund. To refund a portion of the captured amount, specify an amount. If amount is not specified, an amount equal to "captured amount - previous refunds" is refunded. The amount must be a positive number and in the same currency as the one in which the payment was captured.

    • getInvoiceId

      public String getInvoiceId()
      The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

    • getNoteToPayer

      public String getNoteToPayer()
      The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

    • getPaymentInstruction

      public PaymentInstruction getPaymentInstruction()
      Any additional refund instructions to be set during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.