com.paypal.sdk.models

Class VoidPaymentInput

java.lang.Object

com.paypal.sdk.models.VoidPaymentInput

public class VoidPaymentInput
extends Object

This is a model class for VoidPaymentInput type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
VoidPaymentInput() Default constructor.
VoidPaymentInput(String authorizationId, String paypalMockResponse, String paypalAuthAssertion, String paypalRequestId, String prefer) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getAuthorizationId() Getter for AuthorizationId.
String	getPaypalAuthAssertion() Getter for PaypalAuthAssertion.
String	getPaypalMockResponse() Getter for PaypalMockResponse.
String	getPaypalRequestId() Getter for PaypalRequestId.
String	getPrefer() Getter for Prefer.
void	setAuthorizationId(String authorizationId) Setter for AuthorizationId.
void	setPaypalAuthAssertion(String paypalAuthAssertion) Setter for PaypalAuthAssertion.
void	setPaypalMockResponse(String paypalMockResponse) Setter for PaypalMockResponse.
void	setPaypalRequestId(String paypalRequestId) Setter for PaypalRequestId.
void	setPrefer(String prefer) Setter for Prefer.
VoidPaymentInput.Builder	toBuilder() Builds a new VoidPaymentInput.Builder object.
String	toString() Converts this VoidPaymentInput into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoidPaymentInput

public VoidPaymentInput()

Default constructor.

VoidPaymentInput

public VoidPaymentInput(String authorizationId,
                        String paypalMockResponse,
                        String paypalAuthAssertion,
                        String paypalRequestId,
                        String prefer)

Initialization constructor.

Parameters:

authorizationId - String value for authorizationId.

paypalMockResponse - String value for paypalMockResponse.

paypalAuthAssertion - String value for paypalAuthAssertion.

paypalRequestId - String value for paypalRequestId.

prefer - String value for prefer.

Method Detail

getAuthorizationId

public String getAuthorizationId()

Getter for AuthorizationId. The PayPal-generated ID for the authorized payment to void.

Returns:

Returns the String

setAuthorizationId

public void setAuthorizationId(String authorizationId)

Setter for AuthorizationId. The PayPal-generated ID for the authorized payment to void.

Parameters:

authorizationId - Value for 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

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](/docs/api/reference/api-requests/#paypal-auth-assertion). Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.

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](/docs/api/reference/api-requests/#paypal-auth-assertion). Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.

Parameters:

paypalAuthAssertion - Value for String

getPaypalRequestId

public String getPaypalRequestId()

Getter for PaypalRequestId. The server stores keys for 45 days.

Returns:

Returns the String

setPaypalRequestId

public void setPaypalRequestId(String paypalRequestId)

Setter for PaypalRequestId. The server stores keys for 45 days.

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

toString

public String toString()

Converts this VoidPaymentInput into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public VoidPaymentInput.Builder toBuilder()

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

Returns:

a new VoidPaymentInput.Builder object