Capture (rest-api-sdk 1.14.0 API)

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

public class Capture
extends PayPalResource

Constructor Summary

Constructors
Constructor and Description

Capture()
Default Constructor

Constructors
Constructor and Description
`Capture()` 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 Capture`	`get(APIContext apiContext, java.lang.String captureId)` Shows details for a captured payment, by ID.
`static Capture`	`get(java.lang.String accessToken, java.lang.String captureId)` Deprecated. Please use `get(APIContext, String)` instead.
`Amount`	`getAmount()` The amount to capture.
`java.lang.String`	`getCreateTime()` The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
`java.lang.String`	`getId()` The ID of the capture transaction.
`java.lang.String`	`getInvoiceNumber()` The invoice number to track this payment.
`java.lang.Boolean`	`getIsFinalCapture()` Indicates whether to release all remaining funds that the authorization holds in the funding instrument.
`java.util.List<Links>`	`getLinks()`
`java.lang.String`	`getParentPayment()` The ID of the payment on which this transaction is based.
`java.lang.String`	`getReasonCode()` The reason code that describes why the transaction state is pending or reversed.
`java.lang.String`	`getState()` The state of the capture.
`Currency`	`getTransactionFee()` The transaction fee for this payment.
`java.lang.String`	`getUpdateTime()` The date and time when the resource was last updated.
`int`	`hashCode()`
`Refund`	`refund(APIContext apiContext, Refund refund)` Deprecated. Please use `refund(APIContext, RefundRequest)` instead Refunds a captured payment, by ID. Include an `amount` object in the JSON request body.
`DetailedRefund`	`refund(APIContext apiContext, RefundRequest refundRequest)` Refunds a captured payment, by ID.
`Refund`	`refund(java.lang.String accessToken, Refund refund)` Deprecated. Please use `refund(APIContext, Refund)` instead.
`Capture`	`setAmount(Amount amount)` The amount to capture.
`Capture`	`setCreateTime(java.lang.String createTime)` The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
`Capture`	`setId(java.lang.String id)` The ID of the capture transaction.
`Capture`	`setInvoiceNumber(java.lang.String invoiceNumber)` The invoice number to track this payment.
`Capture`	`setIsFinalCapture(java.lang.Boolean isFinalCapture)` Indicates whether to release all remaining funds that the authorization holds in the funding instrument.
`Capture`	`setLinks(java.util.List<Links> links)`
`Capture`	`setParentPayment(java.lang.String parentPayment)` The ID of the payment on which this transaction is based.
`Capture`	`setReasonCode(java.lang.String reasonCode)` The reason code that describes why the transaction state is pending or reversed.
`Capture`	`setState(java.lang.String state)` The state of the capture.
`Capture`	`setTransactionFee(Currency transactionFee)` The transaction fee for this payment.
`Capture`	`setUpdateTime(java.lang.String updateTime)` The date and time when 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
  - Capture
```
public Capture()
```
    Default Constructor
- Method Detail
  - get
```
public static Capture get(java.lang.String accessToken,
                          java.lang.String captureId)
                   throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Shows details for a captured payment, by ID.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    captureId - String
    
    Returns:
    
    Capture
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Capture get(APIContext apiContext,
                          java.lang.String captureId)
                   throws PayPalRESTException
```
    Shows details for a captured payment, by ID.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    captureId - String
    
    Returns:
    
    Capture
    
    Throws:
    
    PayPalRESTException
  - refund
```
public Refund refund(java.lang.String accessToken,
                     Refund refund)
              throws PayPalRESTException
```
    Deprecated. Please use refund(APIContext, Refund) instead.
    
    Creates (and processes) a new Refund Transaction added as a related resource.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    refund - Refund
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - refund
```
public Refund refund(APIContext apiContext,
                     Refund refund)
              throws PayPalRESTException
```
    Deprecated. Please use refund(APIContext, RefundRequest) instead Refunds a captured payment, by ID. Include an `amount` object in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refund - Refund
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - refund
```
public DetailedRefund refund(APIContext apiContext,
                             RefundRequest refundRequest)
                      throws PayPalRESTException
```
    Refunds a captured payment, by ID. Include an `amount` object in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refundRequest - RefundRequest
    
    Returns:
    
    DetailedRefund
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    The ID of the capture transaction.
  - getAmount
```
public Amount getAmount()
```
    The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to `captured`. If not, the state of the authorization changes to `partially_captured`.
  - getIsFinalCapture
```
public java.lang.Boolean getIsFinalCapture()
```
    Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is `false`.
  - getState
```
public java.lang.String getState()
```
    The state of the capture.
  - getReasonCode
```
public java.lang.String getReasonCode()
```
    The reason code that describes why the transaction state is pending or reversed.
  - getParentPayment
```
public java.lang.String getParentPayment()
```
    The ID of the payment on which this transaction is based.
  - getInvoiceNumber
```
public java.lang.String getInvoiceNumber()
```
    The invoice number to track this payment.
  - getTransactionFee
```
public Currency getTransactionFee()
```
    The transaction fee for this payment.
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    The date and time when the resource was last updated.
  - getLinks
```
public java.util.List<Links> getLinks()
```
  - setId
```
public Capture setId(java.lang.String id)
```
    The ID of the capture transaction.
    
    Returns:
    
    this
  - setAmount
```
public Capture setAmount(Amount amount)
```
    The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to `captured`. If not, the state of the authorization changes to `partially_captured`.
    
    Returns:
    
    this
  - setIsFinalCapture
```
public Capture setIsFinalCapture(java.lang.Boolean isFinalCapture)
```
    Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is `false`.
    
    Returns:
    
    this
  - setState
```
public Capture setState(java.lang.String state)
```
    The state of the capture.
    
    Returns:
    
    this
  - setReasonCode
```
public Capture setReasonCode(java.lang.String reasonCode)
```
    The reason code that describes why the transaction state is pending or reversed.
    
    Returns:
    
    this
  - setParentPayment
```
public Capture setParentPayment(java.lang.String parentPayment)
```
    The ID of the payment on which this transaction is based.
    
    Returns:
    
    this
  - setInvoiceNumber
```
public Capture setInvoiceNumber(java.lang.String invoiceNumber)
```
    The invoice number to track this payment.
    
    Returns:
    
    this
  - setTransactionFee
```
public Capture setTransactionFee(Currency transactionFee)
```
    The transaction fee for this payment.
    
    Returns:
    
    this
  - setCreateTime
```
public Capture setCreateTime(java.lang.String createTime)
```
    The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setUpdateTime
```
public Capture setUpdateTime(java.lang.String updateTime)
```
    The date and time when the resource was last updated.
    
    Returns:
    
    this
  - setLinks
```
public Capture 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 Capture

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

Capture

Method Detail

get

get

refund

refund

refund

getId

getAmount

getIsFinalCapture

getState

getReasonCode

getParentPayment

getInvoiceNumber

getTransactionFee

getCreateTime

getUpdateTime

getLinks

setId

setAmount

setIsFinalCapture

setState

setReasonCode

setParentPayment

setInvoiceNumber

setTransactionFee

setCreateTime

setUpdateTime

setLinks

equals

canEqual

hashCode