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

Class CaptureRequest

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

  • Constructor Details

    • CaptureRequest

      public CaptureRequest()

  • Method Details

    • setAmount

      public void setAmount(Money amount)
      The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured.

    • setFinalCapture

      public void setFinalCapture(Boolean finalCapture)
      Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.

    • 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)
      An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

    • setPaymentInstruction

      public void setPaymentInstruction(PaymentInstruction paymentInstruction)
      Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

    • setSoftDescriptor

      public void setSoftDescriptor(String softDescriptor)
      The payment descriptor on the payer's account statement.

    • getAmount

      public Money getAmount()
      The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured.

    • getFinalCapture

      public Boolean getFinalCapture()
      Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.

    • 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()
      An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

    • getPaymentInstruction

      public PaymentInstruction getPaymentInstruction()
      Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

    • getSoftDescriptor

      public String getSoftDescriptor()
      The payment descriptor on the payer's account statement.