com.paypal.sdk.models

Class CaptureOrderInput

java.lang.Object

com.paypal.sdk.models.CaptureOrderInput

public class CaptureOrderInput
extends Object

This is a model class for CaptureOrderInput type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CaptureOrderInput() Default constructor.
CaptureOrderInput(String id, String contentType, String paypalMockResponse, String paypalRequestId, String prefer, String paypalClientMetadataId, String paypalAuthAssertion, OrderCaptureRequest body) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
OrderCaptureRequest	getBody() Getter for Body.
String	getContentType() Getter for ContentType.
String	getId() Getter for Id.
String	getPaypalAuthAssertion() Getter for PaypalAuthAssertion.
String	getPaypalClientMetadataId() Getter for PaypalClientMetadataId.
String	getPaypalMockResponse() Getter for PaypalMockResponse.
String	getPaypalRequestId() Getter for PaypalRequestId.
String	getPrefer() Getter for Prefer.
void	setBody(OrderCaptureRequest body) Setter for Body.
void	setId(String id) Setter for Id.
void	setPaypalAuthAssertion(String paypalAuthAssertion) Setter for PaypalAuthAssertion.
void	setPaypalClientMetadataId(String paypalClientMetadataId) Setter for PaypalClientMetadataId.
void	setPaypalMockResponse(String paypalMockResponse) Setter for PaypalMockResponse.
void	setPaypalRequestId(String paypalRequestId) Setter for PaypalRequestId.
void	setPrefer(String prefer) Setter for Prefer.
CaptureOrderInput.Builder	toBuilder() Builds a new CaptureOrderInput.Builder object.
String	toString() Converts this CaptureOrderInput into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptureOrderInput

public CaptureOrderInput()

Default constructor.

CaptureOrderInput

public CaptureOrderInput(String id,
                         String contentType,
                         String paypalMockResponse,
                         String paypalRequestId,
                         String prefer,
                         String paypalClientMetadataId,
                         String paypalAuthAssertion,
                         OrderCaptureRequest body)

Initialization constructor.

Parameters:

id - String value for id.

contentType - String value for contentType.

paypalMockResponse - String value for paypalMockResponse.

paypalRequestId - String value for paypalRequestId.

prefer - String value for prefer.

paypalClientMetadataId - String value for paypalClientMetadataId.

paypalAuthAssertion - String value for paypalAuthAssertion.

body - OrderCaptureRequest value for body.

Method Detail

getId

public String getId()

Getter for Id. The ID of the order for which to capture a payment.

Returns:

Returns the String

setId

public void setId(String id)

Setter for Id. The ID of the order for which to capture a payment.

Parameters:

id - Value for String

getContentType

public String getContentType()

Getter for ContentType.

Returns:

Returns the String

getPaypalMockResponse

public String getPaypalMockResponse()

Getter for PaypalMockResponse. PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant.

Returns:

Returns the String

setPaypalMockResponse

public void setPaypalMockResponse(String paypalMockResponse)

Setter for PaypalMockResponse. PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant.

Parameters:

paypalMockResponse - Value for String

getPaypalRequestId

public String getPaypalRequestId()

Getter for PaypalRequestId. The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).

Returns:

Returns the String

setPaypalRequestId

public void setPaypalRequestId(String paypalRequestId)

Setter for PaypalRequestId. The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).

Parameters:

paypalRequestId - Value for String

getPrefer

public String getPrefer()

Getter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Returns:

Returns the String

setPrefer

public void setPrefer(String prefer)

Setter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Parameters:

prefer - Value for String

getPaypalClientMetadataId

public String getPaypalClientMetadataId()

Getter for PaypalClientMetadataId.

Returns:

Returns the String

setPaypalClientMetadataId

public void setPaypalClientMetadataId(String paypalClientMetadataId)

Setter for PaypalClientMetadataId.

Parameters:

paypalClientMetadataId - Value for String

getPaypalAuthAssertion

public String getPaypalAuthAssertion()

Getter for PaypalAuthAssertion. An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Returns:

Returns the String

setPaypalAuthAssertion

public void setPaypalAuthAssertion(String paypalAuthAssertion)

Setter for PaypalAuthAssertion. An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Parameters:

paypalAuthAssertion - Value for String

getBody

public OrderCaptureRequest getBody()

Getter for Body.

Returns:

Returns the OrderCaptureRequest

setBody

public void setBody(OrderCaptureRequest body)

Setter for Body.

Parameters:

body - Value for OrderCaptureRequest

toString

public String toString()

Converts this CaptureOrderInput into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CaptureOrderInput.Builder toBuilder()

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

Returns:

a new CaptureOrderInput.Builder object