PayPal-PHP-Server-SDK/doc/models/payments-capture.md

Payments Capture

A captured payment.

Structure

PaymentsCapture

Fields

Name	Type	Tags	Description	Getter	Setter
status	?string(CaptureStatus)	Optional	The status of the captured payment.	getStatus(): ?string	setStatus(?string status): void
statusDetails	?CaptureStatusDetails	Optional	The details of the captured payment status.	getStatusDetails(): ?CaptureStatusDetails	setStatusDetails(?CaptureStatusDetails statusDetails): void
id	?string	Optional	The PayPal-generated ID for the captured payment.	getId(): ?string	setId(?string id): void
amount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getAmount(): ?Money	setAmount(?Money amount): void
invoiceId	?string	Optional	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.	getInvoiceId(): ?string	setInvoiceId(?string invoiceId): void
customId	?string	Optional	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. Constraints: Maximum Length: 255	getCustomId(): ?string	setCustomId(?string customId): void
networkTransactionReference	?NetworkTransactionReference	Optional	Reference values used by the card network to identify a transaction.	getNetworkTransactionReference(): ?NetworkTransactionReference	setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void
sellerProtection	?SellerProtection	Optional	The level of protection offered as defined by PayPal Seller Protection for Merchants.	getSellerProtection(): ?SellerProtection	setSellerProtection(?SellerProtection sellerProtection): void
finalCapture	?bool	Optional	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. Default: false	getFinalCapture(): ?bool	setFinalCapture(?bool finalCapture): void
sellerReceivableBreakdown	?SellerReceivableBreakdown	Optional	The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.	getSellerReceivableBreakdown(): ?SellerReceivableBreakdown	setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void
disbursementMode	?string(DisbursementMode)	Optional	The funds that are held on behalf of the merchant. Default: DisbursementMode::INSTANT Constraints: Minimum Length: 1, Maximum Length: 16, Pattern: ^[A-Z_]+$	getDisbursementMode(): ?string	setDisbursementMode(?string disbursementMode): void
links	?(LinkDescription[])	Optional	An array of related HATEOAS links.	getLinks(): ?array	setLinks(?array links): void
processorResponse	?PaymentsProcessorResponse	Optional	The processor response information for payment requests, such as direct credit card transactions.	getProcessorResponse(): ?PaymentsProcessorResponse	setProcessorResponse(?PaymentsProcessorResponse processorResponse): void
createTime	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	getCreateTime(): ?string	setCreateTime(?string createTime): void
updateTime	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	getUpdateTime(): ?string	setUpdateTime(?string updateTime): void

Example (as JSON)

{
  "final_capture": false,
  "disbursement_mode": "INSTANT",
  "status": "COMPLETED",
  "status_details": {
    "reason": "VERIFICATION_REQUIRED"
  },
  "id": "id0",
  "amount": {
    "currency_code": "currency_code6",
    "value": "value0"
  },
  "invoice_id": "invoice_id0"
}