com.paypal.sdk.models

Class RefundRequest

java.lang.Object

com.paypal.sdk.models.RefundRequest

public class RefundRequest
extends Object

This is a model class for RefundRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RefundRequest() Default constructor.
RefundRequest(Money amount, String customId, String invoiceId, String noteToPayer, RefundPaymentInstruction paymentInstruction) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Money	getAmount() Getter for Amount.
String	getCustomId() Getter for CustomId.
String	getInvoiceId() Getter for InvoiceId.
String	getNoteToPayer() Getter for NoteToPayer.
RefundPaymentInstruction	getPaymentInstruction() Getter for PaymentInstruction.
void	setAmount(Money amount) Setter for Amount.
void	setCustomId(String customId) Setter for CustomId.
void	setInvoiceId(String invoiceId) Setter for InvoiceId.
void	setNoteToPayer(String noteToPayer) Setter for NoteToPayer.
void	setPaymentInstruction(RefundPaymentInstruction paymentInstruction) Setter for PaymentInstruction.
RefundRequest.Builder	toBuilder() Builds a new RefundRequest.Builder object.
String	toString() Converts this RefundRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefundRequest

public RefundRequest()

Default constructor.

RefundRequest

public RefundRequest(Money amount,
                     String customId,
                     String invoiceId,
                     String noteToPayer,
                     RefundPaymentInstruction paymentInstruction)

Initialization constructor.

Parameters:

amount - Money value for amount.

customId - String value for customId.

invoiceId - String value for invoiceId.

noteToPayer - String value for noteToPayer.

paymentInstruction - RefundPaymentInstruction value for paymentInstruction.

Method Detail

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

getCustomId

public String getCustomId()

Getter for CustomId. The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. The pattern is defined by an external party and supports Unicode.

Returns:

Returns the String

setCustomId

public void setCustomId(String customId)

Setter for CustomId. The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. The pattern is defined by an external party and supports Unicode.

Parameters:

customId - Value for String

getInvoiceId

public String getInvoiceId()

Getter for InvoiceId. The API caller-provided external invoice ID for this order. The pattern is defined by an external party and supports Unicode.

Returns:

Returns the String

setInvoiceId

public void setInvoiceId(String invoiceId)

Setter for InvoiceId. The API caller-provided external invoice ID for this order. The pattern is defined by an external party and supports Unicode.

Parameters:

invoiceId - Value for String

getNoteToPayer

public String getNoteToPayer()

Getter for NoteToPayer. The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. The pattern is defined by an external party and supports Unicode.

Returns:

Returns the String

setNoteToPayer

public void setNoteToPayer(String noteToPayer)

Setter for NoteToPayer. The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. The pattern is defined by an external party and supports Unicode.

Parameters:

noteToPayer - Value for String

getPaymentInstruction

public RefundPaymentInstruction getPaymentInstruction()

Getter for PaymentInstruction. Any additional payments instructions 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.

Returns:

Returns the RefundPaymentInstruction

setPaymentInstruction

public void setPaymentInstruction(RefundPaymentInstruction paymentInstruction)

Setter for PaymentInstruction. Any additional payments instructions 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.

Parameters:

paymentInstruction - Value for RefundPaymentInstruction

toString

public String toString()

Converts this RefundRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public RefundRequest.Builder toBuilder()

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

Returns:

a new RefundRequest.Builder object