Refund (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.base.rest.PayPalResource
  - - com.paypal.api.payments.Refund

Direct Known Subclasses:: DetailedRefund

public class Refund
extends PayPalResource

Constructor Summary

Constructors
Constructor and Description

Refund()
Default Constructor

Constructors
Constructor and Description
`Refund()` Default Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`static Refund`	`get(APIContext apiContext, java.lang.String refundId)` Shows details for a refund, by ID.
`static Refund`	`get(java.lang.String accessToken, java.lang.String refundId)` Deprecated. Please use `get(APIContext, String)` instead.
`Amount`	`getAmount()` Details including both refunded amount (to payer) and refunded fee (to payee).
`java.lang.String`	`getCaptureId()` ID of the sale transaction being refunded.
`java.lang.String`	`getCreateTime()` Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
`java.lang.String`	`getDescription()` Description of what is being refunded for.
`java.lang.String`	`getId()` ID of the refund transaction.
`java.lang.String`	`getInvoiceNumber()` Your own invoice or tracking ID number.
`java.util.List<Links>`	`getLinks()`
`java.lang.String`	`getParentPayment()` ID of the payment resource on which this transaction is based.
`java.lang.String`	`getReason()` Reason description for the Sale transaction being refunded.
`java.lang.String`	`getReasonCode()` The reason code for the refund state being pending
`java.lang.String`	`getSaleId()` ID of the Sale transaction being refunded.
`java.lang.String`	`getState()` State of the refund.
`java.lang.String`	`getUpdateTime()` Time that the resource was last updated.
`int`	`hashCode()`
`Refund`	`setAmount(Amount amount)` Details including both refunded amount (to payer) and refunded fee (to payee).
`Refund`	`setCaptureId(java.lang.String captureId)` ID of the sale transaction being refunded.
`Refund`	`setCreateTime(java.lang.String createTime)` Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
`Refund`	`setDescription(java.lang.String description)` Description of what is being refunded for.
`Refund`	`setId(java.lang.String id)` ID of the refund transaction.
`Refund`	`setInvoiceNumber(java.lang.String invoiceNumber)` Your own invoice or tracking ID number.
`Refund`	`setLinks(java.util.List<Links> links)`
`Refund`	`setParentPayment(java.lang.String parentPayment)` ID of the payment resource on which this transaction is based.
`Refund`	`setReason(java.lang.String reason)` Reason description for the Sale transaction being refunded.
`Refund`	`setReasonCode(java.lang.String reasonCode)` The reason code for the refund state being pending
`Refund`	`setSaleId(java.lang.String saleId)` ID of the Sale transaction being refunded.
`Refund`	`setState(java.lang.String state)` State of the refund.
`Refund`	`setUpdateTime(java.lang.String updateTime)` Time that the resource was last updated.

Methods inherited from class com.paypal.base.rest.PayPalResource
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel
toJSON, toString

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

- Constructor Detail
  - Refund
```
public Refund()
```
    Default Constructor
- Method Detail
  - get
```
public static Refund get(java.lang.String accessToken,
                         java.lang.String refundId)
                  throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Shows details for a refund, by ID.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    refundId - String
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Refund get(APIContext apiContext,
                         java.lang.String refundId)
                  throws PayPalRESTException
```
    Shows details for a refund, by ID.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refundId - String
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    ID of the refund transaction. 17 characters max.
  - getAmount
```
public Amount getAmount()
```
    Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
  - getState
```
public java.lang.String getState()
```
    State of the refund.
  - getReason
```
public java.lang.String getReason()
```
    Reason description for the Sale transaction being refunded.
  - getInvoiceNumber
```
public java.lang.String getInvoiceNumber()
```
    Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
  - getSaleId
```
public java.lang.String getSaleId()
```
    ID of the Sale transaction being refunded.
  - getCaptureId
```
public java.lang.String getCaptureId()
```
    ID of the sale transaction being refunded.
  - getParentPayment
```
public java.lang.String getParentPayment()
```
    ID of the payment resource on which this transaction is based.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of what is being refunded for.
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    Time that the resource was last updated.
  - getReasonCode
```
public java.lang.String getReasonCode()
```
    The reason code for the refund state being pending
  - getLinks
```
public java.util.List<Links> getLinks()
```
  - setId
```
public Refund setId(java.lang.String id)
```
    ID of the refund transaction. 17 characters max.
    
    Returns:
    
    this
  - setAmount
```
public Refund setAmount(Amount amount)
```
    Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
    
    Returns:
    
    this
  - setState
```
public Refund setState(java.lang.String state)
```
    State of the refund.
    
    Returns:
    
    this
  - setReason
```
public Refund setReason(java.lang.String reason)
```
    Reason description for the Sale transaction being refunded.
    
    Returns:
    
    this
  - setInvoiceNumber
```
public Refund setInvoiceNumber(java.lang.String invoiceNumber)
```
    Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
    
    Returns:
    
    this
  - setSaleId
```
public Refund setSaleId(java.lang.String saleId)
```
    ID of the Sale transaction being refunded.
    
    Returns:
    
    this
  - setCaptureId
```
public Refund setCaptureId(java.lang.String captureId)
```
    ID of the sale transaction being refunded.
    
    Returns:
    
    this
  - setParentPayment
```
public Refund setParentPayment(java.lang.String parentPayment)
```
    ID of the payment resource on which this transaction is based.
    
    Returns:
    
    this
  - setDescription
```
public Refund setDescription(java.lang.String description)
```
    Description of what is being refunded for.
    
    Returns:
    
    this
  - setCreateTime
```
public Refund setCreateTime(java.lang.String createTime)
```
    Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setUpdateTime
```
public Refund setUpdateTime(java.lang.String updateTime)
```
    Time that the resource was last updated.
    
    Returns:
    
    this
  - setReasonCode
```
public Refund setReasonCode(java.lang.String reasonCode)
```
    The reason code for the refund state being pending
    
    Returns:
    
    this
  - setLinks
```
public Refund setLinks(java.util.List<Links> links)
```
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class PayPalModel
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class PayPalModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PayPalModel

Class Refund

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalResource

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Refund

Method Detail

get

get

getId

getAmount

getState

getReason

getInvoiceNumber

getSaleId

getCaptureId

getParentPayment

getDescription

getCreateTime

getUpdateTime

getReasonCode

getLinks

setId

setAmount

setState

setReason

setInvoiceNumber

setSaleId

setCaptureId

setParentPayment

setDescription

setCreateTime

setUpdateTime

setReasonCode

setLinks

equals

canEqual

hashCode