com.paypal.sdk.models

Class CaptureRequest

java.lang.Object

com.paypal.sdk.models.CaptureRequest

public class CaptureRequest
extends Object

This is a model class for CaptureRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CaptureRequest.Builder Class to build instances of CaptureRequest.

Constructor Summary

Constructors

Constructor and Description
CaptureRequest() Default constructor.
CaptureRequest(String invoiceId, String noteToPayer, Money amount, Boolean finalCapture, CapturePaymentInstruction paymentInstruction, String softDescriptor) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Money	getAmount() Getter for Amount.
Boolean	getFinalCapture() Getter for FinalCapture.
String	getInvoiceId() Getter for InvoiceId.
String	getNoteToPayer() Getter for NoteToPayer.
CapturePaymentInstruction	getPaymentInstruction() Getter for PaymentInstruction.
String	getSoftDescriptor() Getter for SoftDescriptor.
void	setAmount(Money amount) Setter for Amount.
void	setFinalCapture(Boolean finalCapture) Setter for FinalCapture.
void	setInvoiceId(String invoiceId) Setter for InvoiceId.
void	setNoteToPayer(String noteToPayer) Setter for NoteToPayer.
void	setPaymentInstruction(CapturePaymentInstruction paymentInstruction) Setter for PaymentInstruction.
void	setSoftDescriptor(String softDescriptor) Setter for SoftDescriptor.
CaptureRequest.Builder	toBuilder() Builds a new CaptureRequest.Builder object.
String	toString() Converts this CaptureRequest into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CaptureRequest

public CaptureRequest()

Default constructor.

CaptureRequest

public CaptureRequest(String invoiceId,
                      String noteToPayer,
                      Money amount,
                      Boolean finalCapture,
                      CapturePaymentInstruction paymentInstruction,
                      String softDescriptor)

Initialization constructor.

Parameters:

invoiceId - String value for invoiceId.

noteToPayer - String value for noteToPayer.

amount - Money value for amount.

finalCapture - Boolean value for finalCapture.

paymentInstruction - CapturePaymentInstruction value for paymentInstruction.

softDescriptor - String value for softDescriptor.

Method Detail

getInvoiceId

public String getInvoiceId()

Getter for 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.

Returns:

Returns the String

setInvoiceId

public void setInvoiceId(String invoiceId)

Setter for 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.

Parameters:

invoiceId - Value for String

getNoteToPayer

public String getNoteToPayer()

Getter for NoteToPayer. An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

Returns:

Returns the String

setNoteToPayer

public void setNoteToPayer(String noteToPayer)

Setter for NoteToPayer. An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

Parameters:

noteToPayer - Value for String

getAmount

public Money getAmount()

Getter for Amount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setAmount

public void setAmount(Money amount)

Setter for Amount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

amount - Value for Money

getFinalCapture

public Boolean getFinalCapture()

Getter for 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.

Returns:

Returns the Boolean

setFinalCapture

public void setFinalCapture(Boolean finalCapture)

Setter for 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.

Parameters:

finalCapture - Value for Boolean

getPaymentInstruction

public CapturePaymentInstruction getPaymentInstruction()

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

Returns:

Returns the CapturePaymentInstruction

setPaymentInstruction

public void setPaymentInstruction(CapturePaymentInstruction paymentInstruction)

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

Parameters:

paymentInstruction - Value for CapturePaymentInstruction

getSoftDescriptor

public String getSoftDescriptor()

Getter for SoftDescriptor. The payment descriptor on the payer's account statement.

Returns:

Returns the String

setSoftDescriptor

public void setSoftDescriptor(String softDescriptor)

Setter for SoftDescriptor. The payment descriptor on the payer's account statement.

Parameters:

softDescriptor - Value for String

toString

public String toString()

Converts this CaptureRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CaptureRequest.Builder toBuilder()

Builds a new CaptureRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new CaptureRequest.Builder object