On this page
No Headings
A capture transaction.
objectidstringThe ID of the capture transaction.
amountobjectThe amount to capture. Default is the authorization amount. If that amount is the same as the authorized amount, the authorization state changes to CAPTURED. Otherwise, the authorization state changes to PARTIALLY_CAPTURED. To indicate that this capture is the final capture, set is_final_capture to true.
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:
detailsobjectThe additional details about the payment amount.
subtotalstringThe subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters, which includes:
shippingstringThe shipping fee. Maximum length is 10 characters, which includes:
taxstringThe tax. Maximum length is 10 characters, which includes:
handling_feestringThe handling fee. Maximum length is 10 characters, which includes:
shipping_discountstringThe shipping fee discount. Maximum length is 10 characters, which includes:
insurancestringThe insurance fee. Maximum length is 10 characters, which includes:
gift_wrapstringThe gift wrap fee. Maximum length is 10 characters, which includes:
statusstring"PENDING", "COMPLETED", "REFUNDED", "PARTIALLY_REFUNDED", "DENIED"The status of the capture transaction.
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", "DELAYED_DISBURSEMENT"A reason code that indicates the reason for the transaction state of PENDING or REVERSED.
transaction_feeobjectThe currency and amount of the transaction fee.
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.
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.