eBay Post-Order APIVersion 2.7.7
 

RefundDetailType

This type is used by refundDetail container in the POST /post-order/v2/return/{returnId}/issue_refund and POST /post-order/v2/return/{returnId}/mark_refund_sent methods to specify the total amount of the refund, as well as an itemizedRefundDetail container for each refund type (refund on purchase price, refund on original shipping, or any other costs paid by the buyer). The amount(s) in the itemizedRefundDetail.amount field(s) should equal the amount in the refundDetail.totalAmount field. This type is also used by the actualRefund container in the response of a POST /post-order/v2/return method to provide information about a successful refund for a return.

Types that use RefundDetailType:

Calls that use RefundDetailType:

Fields

donationAmount ( Amount ) [0..?]
This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refund, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code.

Note: This container is not applicable for the following methods:
  • Create Return Request POST /post-order/v2/return
  • Issue Return Refund POST /post-order/v2/return/{returnId}/issue_refund
  • Mark Return Refund Sent POST /post-order/v2/return/{returnId}/mark_refund_sent
See the Field Index to learn which calls use donationAmount.

feeCreditAmount ( Amount ) [0..?]
This container shows the total amount of fees credited towards this refund as per eBay policy.
See the Field Index to learn which calls use feeCreditAmount.

itemizedRefundDetail ( array of ItemizedRefundDetailType ) [0..?]
This container is used to declare a refund that is being issued, or has been issued to the buyer. An itemizedRefundDetail container is required for each different refund type, such as purchase price and original shipping. This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred.
See the Field Index to learn which calls use itemizedRefundDetail.

totalAmount ( Amount ) [0..?]
This container shows the total cumulative amount of the refund issued to the buyer. This value should equal the sum of the values in the itemizedRefundDetail.refundAmount field(s). This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred.
See the Field Index to learn which calls use totalAmount.