On this page
No Headings
The refund transaction details.
objectidstringThe ID of the refund transaction.
amountobjectThe refund amount. Includes both the amount refunded to the payer and 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 number to track this payment.
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.
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.
customstringThe note to the payer in this transaction.
refund_from_transaction_feeobjectThe currency and amount of the transaction fee that is refunded to original the recipient of payment.
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.
refund_from_received_amountobjectThe currency and amount of the refund that is subtracted from the original payment recipient's PayPal balance.
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.
total_refunded_amountobjectThe currency and amount of the total refund from the original purchase. For example, if a payer makes $100 purchase and the payer was refunded $20 a week ago and $30 in this transaction, the gross refund amount is $30 for this transaction and the total refunded amount is $50.
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.