On this page
No Headings
The capture transaction details.
objectidstringThe ID of the capture transaction.
amountobjectThe amount to capture. If the amount matches the originally authorized amount, the state of the authorization changes to captured. Otherwise, the state changes to partially_captured.
currencyrequiredstringThe three-character ISO-4217 currency code. PayPal does not support all currencies.
totalrequiredstringThe total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:
JPY do not support decimals.detailsobjectThe additional details about the payment amount.
Note: For an order authorization or capture, you cannot include the amount details object.subtotalstringThe subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the subtotal parameter.shippingstringThe shipping fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the shipping parameter.taxstringThe tax. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the tax parameter.handling_feestringThe handling fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the handling_fee parameter.shipping_discountstringThe shipping fee discount. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the shipping_discount parameter.insurancestringThe insurance fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the insurance parameter.gift_wrapstringThe gift wrap fee. Maximum length is 10 characters, which includes:
Note: For an order authorization or capture, you cannot include the gift_wrap parameter.is_final_capturebooleanfalseIndicates whether to release all remaining held funds.
statestring"pending", "completed", "refunded", "partially_refunded", "denied"The state of the capture.
reason_codestring"CHARGEBACK", "GUARANTEE", "BUYER_COMPLAINT", "REFUND", "UNCONFIRMED_SHIPPING_ADDRESS", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "PAYMENT_REVIEW", "REGULATORY_REVIEW", "UNILATERAL", "VERIFICATION_REQUIRED", "TRANSACTION_APPROVED_AWAITING_FUNDING", "NONE"The reason code that describes why the transaction state is pending or reversed.
parent_paymentstringThe ID of the payment on which this transaction is based.
invoice_numberstringThe invoice number to track this payment.
transaction_feeobjectThe currency and amount of the transaction fee for this payment. Would not be returned for pending transactions where the funds have not been realized in the payee account.
currencyrequiredstringThe three-character ISO-4217 currency code. PayPal does not support all currencies.
valuerequiredstringThe amount. Includes the specified number of digits after decimal separator for the ISO-4217 currency code.
transaction_fee_in_receivable_currencyobjectThe currency and amount of the PayPal fee for this payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example CNY. Would not be returned for pending transactions where the funds have not been realized in the payee account.
currencyrequiredstringThe three-character ISO-4217 currency code. PayPal does not support all currencies.
valuerequiredstringThe amount. Includes the specified number of digits after decimal separator for the ISO-4217 currency code.
receivable_amountobjectThe net amount and currency that the merchant receives for this transaction in the receivable currency.
currencyrequiredstringThe three-character ISO-4217 currency code. PayPal does not support all currencies.
valuerequiredstringThe amount. Includes the specified number of digits after decimal separator for the ISO-4217 currency code.
exchange_ratestringThe exchange rate applied for this transaction. Returned when there is a currency conversion from the transaction currency to the receivable currency.
note_to_payerstringA free-form field that clients can use to send a note to the payer.
create_timestringdate-timeThe date and time of the capture, in Internet date and time format.
update_timestringdate-timeThe date and time when the resource was last updated, in Internet date and time format.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.