finances API1.3.0

Transaction

This type is used to express the details of one of the following monetary transactions: a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account.

Type that uses Transaction

Call that uses Transaction

Fields

Field
Type
Description
amount
This container shows the dollar value and currency type of the monetary transaction. This field is always returned even when eBay has yet to initiate a payout for the order.
bookingEntry
The enumeration value returned in this field indicates if the monetary transaction amount is a (CREDIT) or a (DEBIT) to the seller's account. Typically, the SALE and CREDIT transaction types are credits to the seller's account, and the REFUND, DISPUTE, SHIPPING_LABEL, and TRANSFER transaction types are debits to the seller's account.
buyer
This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER monetary transaction types.
orderId
The unique identifier of the order associated with the monetary transaction.

Note: eBay rolled out a new Order ID format in June 2019. Until April 2020, the legacy APIs still support both the old and new order ID format, but only the new order ID format is supported in REST-based APIs.
orderLineItems
array of OrderLineItem
This array shows the fees that are deducted from a seller payout for each line item in an order.
paymentsEntity
This string value indicates the entity that is processing the payment.
payoutId
The unique identifier of the seller payout associated with the monetary transaction. This identifier is generated once eBay begins processing the payout for the corresponding order. This field will not be returned if eBay has not yet begun processing the payout for an order.
salesRecordReference
The Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout.

Note: For all orders originating after February 1, 2020, a value of 0 will be returned in this field. The Sales Record Number field has also been removed from Seller Hub. Instead of salesRecordReference, depend on orderId instead as the identifier of the order. The salesRecordReference field has been scheduled for deprecation, and a date for when this field will no longer be returned at all will be announced soon.
totalFeeBasisAmount
This amount is the total amount of the order before selling fees are deducted from the seller payout associated with the order. To determine the actual amount of the order that will be paid out through a seller payout, deduct the totalFeeAmount from the basePayoutAmount.
totalFeeAmount
This amount is the total amount of selling fees paid for order. A breakdown of fees for each order line item can be found in the orderLineItems array.

This field is even returned if it is 0.0 (no fees deducted from seller payout).
transactionDate
This timestamp indicates when the monetary transaction (order purchase, buyer refund, seller credit) occurred. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z.
transactionId
The unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller's account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute.
transactionMemo
This field provides more details on a shipping label transaction, such as a purchase, a refund, or a price adjustment to the cost of the shipping label.

This field is only returned if applicable/available. Currently, this field is only used for shipping label transactions, but it is possible that it will be used for other transaction types in the future.
transactionStatus
This enumeration value indicates the current status of the seller payout associated with the monetary transaction. See the TransactionStatusEnum type for more information on the different states.
transactionType
This enumeration value indicates whether the monetary transaction is a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, a credit issued by eBay to the seller's account, a payment dispute between the buyer and seller, or where eBay is billing the seller for an eBay shipping label or another charge (such as a refund to a buyer). Note that the shipping label functionality will initially only be available to a select number of sellers.