CapturedPayment (PayPal Server SDK 1.0.0 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`CapturedPayment()` Default constructor.
CapturedPayment(CaptureStatus status, CaptureStatusDetails statusDetails, String id, Money amount, String invoiceId, String customId, NetworkTransactionReference networkTransactionReference, SellerProtection sellerProtection, Boolean finalCapture, SellerReceivableBreakdown sellerReceivableBreakdown, DisbursementMode disbursementMode, List<LinkDescription> links, PaymentsProcessorResponse processorResponse, String createTime, String updateTime, PaymentSupplementaryData supplementaryData, PayeeBase payee) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Money`	`getAmount()` Getter for Amount.
`String`	`getCreateTime()` Getter for CreateTime.
`String`	`getCustomId()` Getter for CustomId.
`DisbursementMode`	`getDisbursementMode()` Getter for DisbursementMode.
`Boolean`	`getFinalCapture()` Getter for FinalCapture.
`String`	`getId()` Getter for Id.
`String`	`getInvoiceId()` Getter for InvoiceId.
`List<LinkDescription>`	`getLinks()` Getter for Links.
`NetworkTransactionReference`	`getNetworkTransactionReference()` Getter for NetworkTransactionReference.
`PayeeBase`	`getPayee()` Getter for Payee.
`PaymentsProcessorResponse`	`getProcessorResponse()` Getter for ProcessorResponse.
`SellerProtection`	`getSellerProtection()` Getter for SellerProtection.
`SellerReceivableBreakdown`	`getSellerReceivableBreakdown()` Getter for SellerReceivableBreakdown.
`CaptureStatus`	`getStatus()` Getter for Status.
`CaptureStatusDetails`	`getStatusDetails()` Getter for StatusDetails.
`PaymentSupplementaryData`	`getSupplementaryData()` Getter for SupplementaryData.
`String`	`getUpdateTime()` Getter for UpdateTime.
`void`	`setAmount(Money amount)` Setter for Amount.
`void`	`setCreateTime(String createTime)` Setter for CreateTime.
`void`	`setCustomId(String customId)` Setter for CustomId.
`void`	`setDisbursementMode(DisbursementMode disbursementMode)` Setter for DisbursementMode.
`void`	`setFinalCapture(Boolean finalCapture)` Setter for FinalCapture.
`void`	`setId(String id)` Setter for Id.
`void`	`setInvoiceId(String invoiceId)` Setter for InvoiceId.
`void`	`setLinks(List<LinkDescription> links)` Setter for Links.
`void`	`setNetworkTransactionReference(NetworkTransactionReference networkTransactionReference)` Setter for NetworkTransactionReference.
`void`	`setPayee(PayeeBase payee)` Setter for Payee.
`void`	`setProcessorResponse(PaymentsProcessorResponse processorResponse)` Setter for ProcessorResponse.
`void`	`setSellerProtection(SellerProtection sellerProtection)` Setter for SellerProtection.
`void`	`setSellerReceivableBreakdown(SellerReceivableBreakdown sellerReceivableBreakdown)` Setter for SellerReceivableBreakdown.
`void`	`setStatus(CaptureStatus status)` Setter for Status.
`void`	`setStatusDetails(CaptureStatusDetails statusDetails)` Setter for StatusDetails.
`void`	`setSupplementaryData(PaymentSupplementaryData supplementaryData)` Setter for SupplementaryData.
`void`	`setUpdateTime(String updateTime)` Setter for UpdateTime.
`CapturedPayment.Builder`	`toBuilder()` Builds a new `CapturedPayment.Builder` object.
`String`	`toString()` Converts this CapturedPayment into string format.

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

- Constructor Detail
  - CapturedPayment
```
public CapturedPayment()
```
    Default constructor.
  - CapturedPayment
```
public CapturedPayment(CaptureStatus status,
                       CaptureStatusDetails statusDetails,
                       String id,
                       Money amount,
                       String invoiceId,
                       String customId,
                       NetworkTransactionReference networkTransactionReference,
                       SellerProtection sellerProtection,
                       Boolean finalCapture,
                       SellerReceivableBreakdown sellerReceivableBreakdown,
                       DisbursementMode disbursementMode,
                       List<LinkDescription> links,
                       PaymentsProcessorResponse processorResponse,
                       String createTime,
                       String updateTime,
                       PaymentSupplementaryData supplementaryData,
                       PayeeBase payee)
```
    Initialization constructor.
    
    Parameters:
    
    status - CaptureStatus value for status.
    
    statusDetails - CaptureStatusDetails value for statusDetails.
    
    id - String value for id.
    
    amount - Money value for amount.
    
    invoiceId - String value for invoiceId.
    
    customId - String value for customId.
    
    networkTransactionReference - NetworkTransactionReference value for networkTransactionReference.
    
    sellerProtection - SellerProtection value for sellerProtection.
    
    finalCapture - Boolean value for finalCapture.
    
    sellerReceivableBreakdown - SellerReceivableBreakdown value for sellerReceivableBreakdown.
    
    disbursementMode - DisbursementMode value for disbursementMode.
    
    links - List of LinkDescription value for links.
    
    processorResponse - PaymentsProcessorResponse value for processorResponse.
    
    createTime - String value for createTime.
    
    updateTime - String value for updateTime.
    
    supplementaryData - PaymentSupplementaryData value for supplementaryData.
    
    payee - PayeeBase value for payee.
- Method Detail
  - getStatus
```
public CaptureStatus getStatus()
```
    Getter for Status. The status of the captured payment.
    
    Returns:
    
    Returns the CaptureStatus
  - setStatus
```
public void setStatus(CaptureStatus status)
```
    Setter for Status. The status of the captured payment.
    
    Parameters:
    
    status - Value for CaptureStatus
  - getStatusDetails
```
public CaptureStatusDetails getStatusDetails()
```
    Getter for StatusDetails. The details of the captured payment status.
    
    Returns:
    
    Returns the CaptureStatusDetails
  - setStatusDetails
```
public void setStatusDetails(CaptureStatusDetails statusDetails)
```
    Setter for StatusDetails. The details of the captured payment status.
    
    Parameters:
    
    statusDetails - Value for CaptureStatusDetails
  - getId
```
public String getId()
```
    Getter for Id. The PayPal-generated ID for the captured payment.
    
    Returns:
    
    Returns the String
  - setId
```
public void setId(String id)
```
    Setter for Id. The PayPal-generated ID for the captured payment.
    
    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
  - getNetworkTransactionReference
```
public NetworkTransactionReference getNetworkTransactionReference()
```
    Getter for NetworkTransactionReference. Reference values used by the card network to identify a transaction.
    
    Returns:
    
    Returns the NetworkTransactionReference
  - setNetworkTransactionReference
```
public void setNetworkTransactionReference(NetworkTransactionReference networkTransactionReference)
```
    Setter for NetworkTransactionReference. Reference values used by the card network to identify a transaction.
    
    Parameters:
    
    networkTransactionReference - Value for NetworkTransactionReference
  - getSellerProtection
```
public SellerProtection getSellerProtection()
```
    Getter for SellerProtection. The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).
    
    Returns:
    
    Returns the SellerProtection
  - setSellerProtection
```
public void setSellerProtection(SellerProtection sellerProtection)
```
    Setter for SellerProtection. The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).
    
    Parameters:
    
    sellerProtection - Value for SellerProtection
  - getFinalCapture
```
public Boolean getFinalCapture()
```
    Getter for FinalCapture. Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.
    
    Returns:
    
    Returns the Boolean
  - setFinalCapture
```
public void setFinalCapture(Boolean finalCapture)
```
    Setter for FinalCapture. Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.
    
    Parameters:
    
    finalCapture - Value for Boolean
  - getSellerReceivableBreakdown
```
public SellerReceivableBreakdown getSellerReceivableBreakdown()
```
    Getter for SellerReceivableBreakdown. The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
    
    Returns:
    
    Returns the SellerReceivableBreakdown
  - setSellerReceivableBreakdown
```
public void setSellerReceivableBreakdown(SellerReceivableBreakdown sellerReceivableBreakdown)
```
    Setter for SellerReceivableBreakdown. The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
    
    Parameters:
    
    sellerReceivableBreakdown - Value for SellerReceivableBreakdown
  - getDisbursementMode
```
public DisbursementMode getDisbursementMode()
```
    Getter for DisbursementMode. The funds that are held on behalf of the merchant.
    
    Returns:
    
    Returns the DisbursementMode
  - setDisbursementMode
```
public void setDisbursementMode(DisbursementMode disbursementMode)
```
    Setter for DisbursementMode. The funds that are held on behalf of the merchant.
    
    Parameters:
    
    disbursementMode - Value for DisbursementMode
  - 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
  - getProcessorResponse
```
public PaymentsProcessorResponse getProcessorResponse()
```
    Getter for ProcessorResponse. The processor response information for payment requests, such as direct credit card transactions.
    
    Returns:
    
    Returns the PaymentsProcessorResponse
  - setProcessorResponse
```
public void setProcessorResponse(PaymentsProcessorResponse processorResponse)
```
    Setter for ProcessorResponse. The processor response information for payment requests, such as direct credit card transactions.
    
    Parameters:
    
    processorResponse - Value for PaymentsProcessorResponse
  - 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
  - getSupplementaryData
```
public PaymentSupplementaryData getSupplementaryData()
```
    Getter for SupplementaryData. The supplementary data.
    
    Returns:
    
    Returns the PaymentSupplementaryData
  - setSupplementaryData
```
public void setSupplementaryData(PaymentSupplementaryData supplementaryData)
```
    Setter for SupplementaryData. The supplementary data.
    
    Parameters:
    
    supplementaryData - Value for PaymentSupplementaryData
  - getPayee
```
public PayeeBase getPayee()
```
    Getter for Payee. 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
  - setPayee
```
public void setPayee(PayeeBase payee)
```
    Setter for Payee. The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
    
    Parameters:
    
    payee - Value for PayeeBase
  - toString
```
public String toString()
```
    Converts this CapturedPayment into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CapturedPayment.Builder toBuilder()
```
    Builds a new CapturedPayment.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CapturedPayment.Builder object

Class CapturedPayment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CapturedPayment

CapturedPayment

Method Detail

getStatus

setStatus

getStatusDetails

setStatusDetails

getId

setId

getAmount

setAmount

getInvoiceId

setInvoiceId

getCustomId

setCustomId

getNetworkTransactionReference

setNetworkTransactionReference

getSellerProtection

setSellerProtection

getFinalCapture

setFinalCapture

getSellerReceivableBreakdown

setSellerReceivableBreakdown

getDisbursementMode

setDisbursementMode

getLinks

setLinks

getProcessorResponse

setProcessorResponse

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getSupplementaryData

setSupplementaryData

getPayee

setPayee

toString

toBuilder