Class Capture
- java.lang.Object
-
- com.broadleafcommerce.paypal.micro.gateway.domain.orders.Capture
-
- All Implemented Interfaces:
Serializable
public class Capture extends Object implements Serializable
A captured payment.- Author:
- Dima Myroniuk (dmyroniuk)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Capture()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Money
getAmount()
The amount for this captured payment.CaptureStatusDetails
getCaptureStatusDetails()
The details of the captured payment status.String
getCreateTime()
The date and time when the transaction occurred, in Internet date and time format.String
getCustomId()
The API caller-provided external ID.String
getDisbursementMode()
The funds that are held on behalf of the merchant.Boolean
getFinalCapture()
Indicates whether you can make additional captures against the authorized payment.String
getId()
The PayPal-generated ID for the captured payment.String
getInvoiceId()
The API caller-provided external invoice number for this order.List<LinkDescription>
getLinks()
An array of related HATEOAS links.ProcessorResponse
getProcessorResponse()
An object that provides additional processor information for a direct credit card transaction.SellerProtection
getSellerProtection()
The level of protection offered as defined by PayPal Seller Protection for Merchants.MerchantReceivableBreakdown
getSellerReceivableBreakdown()
The detailed breakdown of the capture activity.String
getStatus()
The status of the captured payment.String
getUpdateTime()
The date and time when the transaction was last updated, in Internet date and time format.void
setAmount(Money amount)
The amount for this captured payment.void
setCaptureStatusDetails(CaptureStatusDetails captureStatusDetails)
The details of the captured payment status.void
setCreateTime(String createTime)
The date and time when the transaction occurred, in Internet date and time format.void
setCustomId(String customId)
The API caller-provided external ID.void
setDisbursementMode(String disbursementMode)
The funds that are held on behalf of the merchant.void
setFinalCapture(Boolean finalCapture)
Indicates whether you can make additional captures against the authorized payment.void
setId(String id)
The PayPal-generated ID for the captured payment.void
setInvoiceId(String invoiceId)
The API caller-provided external invoice number for this order.void
setLinks(List<LinkDescription> links)
An array of related HATEOAS links.void
setProcessorResponse(ProcessorResponse processorResponse)
An object that provides additional processor information for a direct credit card transaction.void
setSellerProtection(SellerProtection sellerProtection)
The level of protection offered as defined by PayPal Seller Protection for Merchants.void
setSellerReceivableBreakdown(MerchantReceivableBreakdown sellerReceivableBreakdown)
The detailed breakdown of the capture activity.void
setStatus(String status)
The status of the captured payment.void
setUpdateTime(String updateTime)
The date and time when the transaction was last updated, in Internet date and time format.
-
-
-
Method Detail
-
setStatus
public void setStatus(String status)
The status of the captured payment.
-
setCaptureStatusDetails
public void setCaptureStatusDetails(CaptureStatusDetails captureStatusDetails)
The details of the captured payment status.
-
setAmount
public void setAmount(Money amount)
The amount for this captured payment.
-
setCustomId
public void setCustomId(String customId)
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
-
setDisbursementMode
public void setDisbursementMode(String disbursementMode)
The funds that are held on behalf of the merchant.
-
setFinalCapture
public void setFinalCapture(Boolean 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.
-
setId
public void setId(String id)
The PayPal-generated ID for the captured payment.
-
setInvoiceId
public void setInvoiceId(String 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.
-
setLinks
public void setLinks(List<LinkDescription> links)
An array of related HATEOAS links.
-
setProcessorResponse
public void setProcessorResponse(ProcessorResponse processorResponse)
An object that provides additional processor information for a direct credit card transaction.
-
setSellerProtection
public void setSellerProtection(SellerProtection sellerProtection)
The level of protection offered as defined by PayPal Seller Protection for Merchants.
-
setSellerReceivableBreakdown
public void setSellerReceivableBreakdown(MerchantReceivableBreakdown sellerReceivableBreakdown)
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
-
setCreateTime
public void setCreateTime(String createTime)
The date and time when the transaction occurred, in Internet date and time format.
-
setUpdateTime
public void setUpdateTime(String updateTime)
The date and time when the transaction was last updated, in Internet date and time format.
-
getStatus
public String getStatus()
The status of the captured payment.
-
getCaptureStatusDetails
public CaptureStatusDetails getCaptureStatusDetails()
The details of the captured payment status.
-
getAmount
public Money getAmount()
The amount for this captured payment.
-
getCustomId
public String getCustomId()
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
-
getDisbursementMode
public String getDisbursementMode()
The funds that are held on behalf of the merchant.
-
getFinalCapture
public Boolean getFinalCapture()
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.
-
getId
public String getId()
The PayPal-generated ID for the captured payment.
-
getInvoiceId
public String getInvoiceId()
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.
-
getLinks
public List<LinkDescription> getLinks()
An array of related HATEOAS links.
-
getProcessorResponse
public ProcessorResponse getProcessorResponse()
An object that provides additional processor information for a direct credit card transaction.
-
getSellerProtection
public SellerProtection getSellerProtection()
The level of protection offered as defined by PayPal Seller Protection for Merchants.
-
getSellerReceivableBreakdown
public MerchantReceivableBreakdown getSellerReceivableBreakdown()
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
-
getCreateTime
public String getCreateTime()
The date and time when the transaction occurred, in Internet date and time format.
-
getUpdateTime
public String getUpdateTime()
The date and time when the transaction was last updated, in Internet date and time format.
-
-