eBay Trading APIVersion 1487
 

RefundTransactionInfoType

Type defining the Refund container, where the refund could be initiated either from the seller or eBay.

Type that uses RefundTransactionInfoType:

Calls that use RefundTransactionInfoType:

Fields



FeeOrCreditAmount ( AmountType (double) ) [0..1]

Note: Since BOPIS (Buy Online, Pick Up In Store) is no longer available, this container and its associated fields are no longer available for active use in the Trading API.
See the Field Index to learn which calls use FeeOrCreditAmount.


Note: Since BOPIS (Buy Online, Pick Up In Store) is no longer available, this container and its associated fields are no longer available for active use in the Trading API.
See the Field Index to learn which calls use ReferenceID.

RefundAmount ( AmountType (double) ) [0..1]
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.
See the Field Index to learn which calls use RefundAmount.

RefundTime ( dateTime ) [0..1]
This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).
See the Field Index to learn which calls use RefundTime.

RefundTo ( UserIdentityType (string) ) [0..1]
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.
See the Field Index to learn which calls use RefundTo.

Since BOPIS (Buy Online, Pick Up In Store) is no longer supported, this field should no longer be used in the Trading API.
See the Field Index to learn which calls use RefundType.