Refund (PayPal Server SDK 1.0.0 API)

java.lang.Object
- com.paypal.sdk.models.Refund

```
public class Refund
extends Object
```
This is a model class for Refund type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Refund.Builder
Class to build instances of Refund.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Refund.Builder` Class to build instances of `Refund`.

Constructor Summary

Constructors
Constructor and Description
`Refund()` Default constructor.
`Refund(RefundStatus status, RefundStatusDetails statusDetails, String id, Money amount, String invoiceId, String customId, String acquirerReferenceNumber, String noteToPayer, SellerPayableBreakdown sellerPayableBreakdown, PayeeBase payer, List<LinkDescription> links, String createTime, String updateTime)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAcquirerReferenceNumber()` Getter for AcquirerReferenceNumber.
`Money`	`getAmount()` Getter for Amount.
`String`	`getCreateTime()` Getter for CreateTime.
`String`	`getCustomId()` Getter for CustomId.
`String`	`getId()` Getter for Id.
`String`	`getInvoiceId()` Getter for InvoiceId.
`List<LinkDescription>`	`getLinks()` Getter for Links.
`String`	`getNoteToPayer()` Getter for NoteToPayer.
`PayeeBase`	`getPayer()` Getter for Payer.
`SellerPayableBreakdown`	`getSellerPayableBreakdown()` Getter for SellerPayableBreakdown.
`RefundStatus`	`getStatus()` Getter for Status.
`RefundStatusDetails`	`getStatusDetails()` Getter for StatusDetails.
`String`	`getUpdateTime()` Getter for UpdateTime.
`void`	`setAcquirerReferenceNumber(String acquirerReferenceNumber)` Setter for AcquirerReferenceNumber.
`void`	`setAmount(Money amount)` Setter for Amount.
`void`	`setCreateTime(String createTime)` Setter for CreateTime.
`void`	`setCustomId(String customId)` Setter for CustomId.
`void`	`setId(String id)` Setter for Id.
`void`	`setInvoiceId(String invoiceId)` Setter for InvoiceId.
`void`	`setLinks(List<LinkDescription> links)` Setter for Links.
`void`	`setNoteToPayer(String noteToPayer)` Setter for NoteToPayer.
`void`	`setPayer(PayeeBase payer)` Setter for Payer.
`void`	`setSellerPayableBreakdown(SellerPayableBreakdown sellerPayableBreakdown)` Setter for SellerPayableBreakdown.
`void`	`setStatus(RefundStatus status)` Setter for Status.
`void`	`setStatusDetails(RefundStatusDetails statusDetails)` Setter for StatusDetails.
`void`	`setUpdateTime(String updateTime)` Setter for UpdateTime.
`Refund.Builder`	`toBuilder()` Builds a new `Refund.Builder` object.
`String`	`toString()` Converts this Refund into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Refund
```
public Refund()
```
    Default constructor.
  - Refund
```
public Refund(RefundStatus status,
              RefundStatusDetails statusDetails,
              String id,
              Money amount,
              String invoiceId,
              String customId,
              String acquirerReferenceNumber,
              String noteToPayer,
              SellerPayableBreakdown sellerPayableBreakdown,
              PayeeBase payer,
              List<LinkDescription> links,
              String createTime,
              String updateTime)
```
    Initialization constructor.
    
    Parameters:
    
    status - RefundStatus value for status.
    
    statusDetails - RefundStatusDetails value for statusDetails.
    
    id - String value for id.
    
    amount - Money value for amount.
    
    invoiceId - String value for invoiceId.
    
    customId - String value for customId.
    
    acquirerReferenceNumber - String value for acquirerReferenceNumber.
    
    noteToPayer - String value for noteToPayer.
    
    sellerPayableBreakdown - SellerPayableBreakdown value for sellerPayableBreakdown.
    
    payer - PayeeBase value for payer.
    
    links - List of LinkDescription value for links.
    
    createTime - String value for createTime.
    
    updateTime - String value for updateTime.
- Method Detail
  - getStatus
```
public RefundStatus getStatus()
```
    Getter for Status. The status of the refund.
    
    Returns:
    
    Returns the RefundStatus
  - setStatus
```
public void setStatus(RefundStatus status)
```
    Setter for Status. The status of the refund.
    
    Parameters:
    
    status - Value for RefundStatus
  - getStatusDetails
```
public RefundStatusDetails getStatusDetails()
```
    Getter for StatusDetails. The details of the refund status.
    
    Returns:
    
    Returns the RefundStatusDetails
  - setStatusDetails
```
public void setStatusDetails(RefundStatusDetails statusDetails)
```
    Setter for StatusDetails. The details of the refund status.
    
    Parameters:
    
    statusDetails - Value for RefundStatusDetails
  - getId
```
public String getId()
```
    Getter for Id. The PayPal-generated ID for the refund.
    
    Returns:
    
    Returns the String
  - setId
```
public void setId(String id)
```
    Setter for Id. The PayPal-generated ID for the refund.
    
    Parameters:
    
    id - 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
  - 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
  - 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.
    
    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.
    
    Parameters:
    
    customId - Value for String
  - getAcquirerReferenceNumber
```
public String getAcquirerReferenceNumber()
```
    Getter for AcquirerReferenceNumber. Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
    
    Returns:
    
    Returns the String
  - setAcquirerReferenceNumber
```
public void setAcquirerReferenceNumber(String acquirerReferenceNumber)
```
    Setter for AcquirerReferenceNumber. Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
    
    Parameters:
    
    acquirerReferenceNumber - 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.
    
    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.
    
    Parameters:
    
    noteToPayer - Value for String
  - getSellerPayableBreakdown
```
public SellerPayableBreakdown getSellerPayableBreakdown()
```
    Getter for SellerPayableBreakdown. The breakdown of the refund.
    
    Returns:
    
    Returns the SellerPayableBreakdown
  - setSellerPayableBreakdown
```
public void setSellerPayableBreakdown(SellerPayableBreakdown sellerPayableBreakdown)
```
    Setter for SellerPayableBreakdown. The breakdown of the refund.
    
    Parameters:
    
    sellerPayableBreakdown - Value for SellerPayableBreakdown
  - getPayer
```
public PayeeBase getPayer()
```
    Getter for Payer. The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
    
    Returns:
    
    Returns the PayeeBase
  - setPayer
```
public void setPayer(PayeeBase payer)
```
    Setter for Payer. The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
    
    Parameters:
    
    payer - Value for PayeeBase
  - getLinks
```
public List<LinkDescription> getLinks()
```
    Getter for Links. An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    
    Returns:
    
    Returns the List of LinkDescription
  - setLinks
```
public void setLinks(List<LinkDescription> links)
```
    Setter for Links. An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    
    Parameters:
    
    links - Value for List of LinkDescription
  - getCreateTime
```
public String getCreateTime()
```
    Getter for CreateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Returns:
    
    Returns the String
  - setCreateTime
```
public void setCreateTime(String createTime)
```
    Setter for CreateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Parameters:
    
    createTime - Value for String
  - getUpdateTime
```
public String getUpdateTime()
```
    Getter for UpdateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Returns:
    
    Returns the String
  - setUpdateTime
```
public void setUpdateTime(String updateTime)
```
    Setter for UpdateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Parameters:
    
    updateTime - Value for String
  - toString
```
public String toString()
```
    Converts this Refund into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Refund.Builder toBuilder()
```
    Builds a new Refund.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Refund.Builder object

Class Refund

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Refund

Refund

Method Detail

getStatus

setStatus

getStatusDetails

setStatusDetails

getId

setId

getAmount

setAmount

getInvoiceId

setInvoiceId

getCustomId

setCustomId

getAcquirerReferenceNumber

setAcquirerReferenceNumber

getNoteToPayer

setNoteToPayer

getSellerPayableBreakdown

setSellerPayableBreakdown

getPayer

setPayer

getLinks

setLinks

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

toString

toBuilder