On this page
No Headings
An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment.
objectamountobjectThe amount to collect.
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.payeeobjectThe payee who receives the funds and fulfills the order.
emailstringemailThe email address associated with the payee's PayPal account. For an intent of authorize or order, the email address must be associated with a confirmed PayPal business account. For an intent of sale, the email can either:
merchant_idstringThe PayPal account ID for the payee.
descriptionstringThe purchase description.
note_to_payeestringThe note to the recipient of the funds in this transaction.
customstringThe free-form field for the client's use.
invoice_numberstringThe invoice number to track this payment.
soft_descriptorstringThe soft descriptor to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string.
payment_optionsobjectThe payment options for this transaction.
allowed_payment_methodstring"UNRESTRICTED", "INSTANT_FUNDING_SOURCE", "IMMEDIATE_PAY""UNRESTRICTED"The payment method for this transaction. This field does not apply to the credit card payment method.
item_listobjectAn array of items that are being purchased.
itemsarrayAn array of items that are being purchased.
itemsobjectThe item details.
skustringThe stock keeping unit (SKU) for the item.
namestringThe item name. If this value is greater than the maximum allowed length, the API truncates the string.
descriptionstringThe item description. Supported for only the PayPal payment method.
quantityrequiredstring^[0-9]{0,10}$The item quantity. Must be a whole number.
pricerequiredstring^[0-9]{0,10}(\.[0-9]{0,2})?$The item cost. Supports two decimal places.
currencyrequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
taxstringThe item tax. Supported only for the PayPal payment method.
shipping_addressobjectThe shipping address details.
line1requiredstringThe first line of the address. For example, number, street, and so on.
line2stringThe second line of the address. For example, suite or apartment number.
citystringThe city name.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringnormalization_statusstring"UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"The address normalization status. Returned only for payers from Brazil.
typestringThe type of address. For example, HOME_OR_WORK, GIFT, and so on.
recipient_namestringThe name of the recipient at this address.
shipping_methodstringThe shipping method used for this payment, such as USPS Parcel.
shipping_phone_numberstringThe shipping phone number, in its canonical international format as defined by the E.164 numbering plan. Enables merchants to share payer’s contact number with PayPal for the current payment. The final contact number for the payer who is associated with the transaction might be the same as or different from the shipping_phone_number based on the payer’s action on PayPal.
notify_urlstringuriThe URL to send payment notifications.
related_resourcesarrayAn array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment.
itemsobjectThe payment-related financial transactions, which include sales, authorizations, captures, and refunds. To show resource details, use the resource ID. For example, to show details for a related authorization, use the ID returned in the authorization object. You can also use the HATEOAS links for a resource to complete operations for that resource. For example, a sale object provides a refund link that enables you to refund the sale.
saleobjectThe sale transaction details.
idrequiredstringThe ID of the sale transaction.
amountrequiredobjectThe amount to collect.
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.payment_modestring"INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"The transaction payment mode. Supported only for PayPal payments.
staterequiredstring"completed", "partially_refunded", "pending", "refunded", "denied"The state of the sale 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", "TRANSACTION_APPROVED_AWAITING_FUNDING"A reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.
protection_eligibilitystring"ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"The merchant protection level in effect for the transaction. Supported only for PayPal payments.
protection_eligibility_typestring"ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"The merchant protection type in effect for the transaction. Returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.
clearing_timestringdate-timeThe date and time when the PayPal eCheck transaction is expected to clear, in Internet date and time format.
payment_hold_statusstring"HELD"The recipient fund status. Returned only when the fund status is held.
payment_hold_reasonsarrayAn array of reasons that PayPal holds the recipient fund. Set only if the payment hold status is HELD.
itemsobjectThe payment-related financial transactions, which include sales, authorizations, captures, and refunds. To show resource details, use the resource ID. For example, to show details for a related authorization, use the ID returned in the authorization object. You can also use the HATEOAS links for a resource to complete operations for that resource. For example, a sale object provides a refund link that enables you to refund the sale.
payment_hold_reasonstring"PAYMENT_HOLD", "SHIPPING_RISK_HOLD"The reason that PayPal holds the recipient fund. Set only if the payment hold status is HELD.
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.
receivable_amountobjectThe currency and amount of the net that the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
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.
exchange_ratestringThe exchange rate for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
fmf_detailsobjectThe Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary.
filter_typerequiredstring"ACCEPT", "PENDING", "DENY", "REPORT"The filter type.
filter_idrequiredstring"AVS_NO_MATCH", "AVS_PARTIAL_MATCH", "AVS_UNAVAILABLE_OR_UNSUPPORTED", "CARD_SECURITY_CODE_MISMATCH", "MAXIMUM_TRANSACTION_AMOUNT", "UNCONFIRMED_ADDRESS", "COUNTRY_MONITOR", "LARGE_ORDER_NUMBER", "BILLING_OR_SHIPPING_ADDRESS_MISMATCH", "RISKY_ZIP_CODE", "SUSPECTED_FREIGHT_FORWARDER_CHECK", "TOTAL_PURCHASE_PRICE_MINIMUM", "IP_ADDRESS_VELOCITY", "RISKY_EMAIL_ADDRESS_DOMAIN_CHECK", "RISKY_BANK_IDENTIFICATION_NUMBER_CHECK", "RISKY_IP_ADDRESS_RANGE", "PAYPAL_FRAUD_MODEL"The filter ID.
namestringThe filter name.
descriptionstringThe filter description.
receipt_idstring^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$The receipt ID, which is a payment ID number that is returned for guest users to identify the payment.
parent_paymentrequiredstringThe ID of the payment on which this transaction is based.
processor_responseobjectThe processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card.
response_coderequiredstringThe PayPal normalized response code, which is generated from the processor's specific response code.
avs_codestring[A-z0-9]{1}The Address Verification System (AVS) response code.
advice_codestring"01_NEW_ACCOUNT_INFORMATION", "02_TRY_AGAIN_LATER", "02_STOP_SPECIFIC_PAYMENT", "03_DO_NOT_TRY_AGAIN", "03_REVOKE_AUTHORIZATION_FOR_FUTURE_PAYMENT", "21_DO_NOT_TRY_AGAIN_CARD_HOLDER_CANCELLED_RECURRRING_CHARGE", "21_CANCEL_ALL_RECURRING_PAYMENTS"The merchant advice on how to handle declines for recurring payments.
eci_submittedstringThe processor-provided authorization response.
vpasstringThe processor-provided Visa Payer Authentication Service (VPAS) status.
billing_agreement_idstringThe ID of the billing agreement. Used as reference to execute this transaction.
create_timerequiredstringdate-timeThe date and time of the sale, 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.
authorizationobjectThe authorization details.
idstringThe ID of the authorization.
amountrequiredobjectThe amount being authorized.
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.payment_modestring"INSTANT_TRANSFER"The payment mode of the authorization.
statestring"pending", "authorized", "partially_captured", "captured", "expired", "denied", "voided"The authorized payment state.
reason_codestring"AUTHORIZATION"The reason code for the pending transaction state.
pending_reasonstring"AUTHORIZATION"Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.
protection_eligibilitystring"ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"The level of seller protection present for the transaction. Supported for the PayPal payment method only.
protection_eligibility_typestring"ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"The type of seller protection for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported for the PayPal payment method only.
fmf_detailsobjectThe Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary.
filter_typerequiredstring"ACCEPT", "PENDING", "DENY", "REPORT"The filter type.
filter_idrequiredstring"AVS_NO_MATCH", "AVS_PARTIAL_MATCH", "AVS_UNAVAILABLE_OR_UNSUPPORTED", "CARD_SECURITY_CODE_MISMATCH", "MAXIMUM_TRANSACTION_AMOUNT", "UNCONFIRMED_ADDRESS", "COUNTRY_MONITOR", "LARGE_ORDER_NUMBER", "BILLING_OR_SHIPPING_ADDRESS_MISMATCH", "RISKY_ZIP_CODE", "SUSPECTED_FREIGHT_FORWARDER_CHECK", "TOTAL_PURCHASE_PRICE_MINIMUM", "IP_ADDRESS_VELOCITY", "RISKY_EMAIL_ADDRESS_DOMAIN_CHECK", "RISKY_BANK_IDENTIFICATION_NUMBER_CHECK", "RISKY_IP_ADDRESS_RANGE", "PAYPAL_FRAUD_MODEL"The filter ID.
namestringThe filter name.
descriptionstringThe filter description.
parent_paymentstringThe ID of the payment on which this transaction is based.
processor_responseobjectThe processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card.
response_coderequiredstringThe PayPal normalized response code, which is generated from the processor's specific response code.
avs_codestring[A-z0-9]{1}The Address Verification System (AVS) response code.
advice_codestring"01_NEW_ACCOUNT_INFORMATION", "02_TRY_AGAIN_LATER", "02_STOP_SPECIFIC_PAYMENT", "03_DO_NOT_TRY_AGAIN", "03_REVOKE_AUTHORIZATION_FOR_FUTURE_PAYMENT", "21_DO_NOT_TRY_AGAIN_CARD_HOLDER_CANCELLED_RECURRRING_CHARGE", "21_CANCEL_ALL_RECURRING_PAYMENTS"The merchant advice on how to handle declines for recurring payments.
eci_submittedstringThe processor-provided authorization response.
vpasstringThe processor-provided Visa Payer Authentication Service (VPAS) status.
valid_untilstringdate-timeThe date and time when the authorization expires, in Internet date and time format.
create_timestringdate-timeThe date and time when the authorization was created, in Internet date and time format.
update_timestringdate-timeThe date and time when the authorization was last updated, in Internet date and time format.
receipt_idstring^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$The receipt ID, which identifies the payment. Value is 16-digit numeric payment ID number that is returned for guest users.
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.
orderobjectThe order transaction details.
idstringThe ID of the order transaction.
amountrequiredobjectThe amount to collect.
Note: For an order authorization, you cannot include amount details.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.payment_modestring"INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"The transaction payment mode.
statestring"PENDING", "AUTHORIZED", "CAPTURED", "COMPLETED", "VOIDED"The state of the order transaction.
reason_codestring"PAYER_SHIPPING_UNCONFIRMED", "MULTI_CURRENCY", "RISK_REVIEW", "REGULATORY_REVIEW", "VERIFICATION_REQUIRED", "ORDER", "OTHER"The reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.
pending_reasonstring"payer_shipping_unconfirmed", "multi_currency", "risk_review", "regulatory_review", "verification_required", "order", "other"Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.
protection_eligibilitystring"ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"The level of seller protection in effect for the transaction.
protection_eligibility_typestring"ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"The kind of seller protection in effect for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.
parent_paymentstringThe ID of the payment on which this transaction is based.
fmf_detailsobjectThe Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary.
filter_typerequiredstring"ACCEPT", "PENDING", "DENY", "REPORT"The filter type.
filter_idrequiredstring"AVS_NO_MATCH", "AVS_PARTIAL_MATCH", "AVS_UNAVAILABLE_OR_UNSUPPORTED", "CARD_SECURITY_CODE_MISMATCH", "MAXIMUM_TRANSACTION_AMOUNT", "UNCONFIRMED_ADDRESS", "COUNTRY_MONITOR", "LARGE_ORDER_NUMBER", "BILLING_OR_SHIPPING_ADDRESS_MISMATCH", "RISKY_ZIP_CODE", "SUSPECTED_FREIGHT_FORWARDER_CHECK", "TOTAL_PURCHASE_PRICE_MINIMUM", "IP_ADDRESS_VELOCITY", "RISKY_EMAIL_ADDRESS_DOMAIN_CHECK", "RISKY_BANK_IDENTIFICATION_NUMBER_CHECK", "RISKY_IP_ADDRESS_RANGE", "PAYPAL_FRAUD_MODEL"The filter ID.
namestringThe filter name.
descriptionstringThe filter description.
create_timestringdate-timeThe date and time when the resource was created, 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.
captureobjectThe capture transaction details.
idstringThe 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.
refundobjectThe refund details.
idstringThe ID of the refund transaction. Maximum length is 17 characters.
amountobjectThe refund amount. Includes both the amount refunded to the payer and amount of the fee refunded to the payee.
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.statestring"pending", "completed", "cancelled", "failed"The state of the refund.
reasonstringThe reason that the transaction is being refunded.
invoice_numberstringThe invoice or tracking ID number.
sale_idstringThe ID of the sale transaction being refunded.
capture_idstringThe ID of the sale transaction being refunded.
parent_paymentstringThe ID of the payment on which this transaction is based.
descriptionstringThe refund description. Value must be single-byte alphanumeric characters.
create_timestringdate-timeThe date and time when the refund was created, 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.