finances API1.8.0

Payout

This type is used to express the details of one seller payout that is returned with the getPayout or getPayouts methods.

Type that uses Payout

Calls that use Payout

Fields

Field
Type
Description
amount
This the total amount of the seller payout. The container shows the dollar amount of the payout and the currency used. The value of the payout is always shown, even if the payout has failed.
lastAttemptedPayoutDate
This timestamp indicates the date/time when eBay last attempted to process a seller payout but it failed. This field is only returned if a seller payout fails, and the payoutStatus value shows RETRYABLE_FAILED or TERMINAL_FAILED. A seller can filter on the lastAttemptedPayoutDate in a getPayouts request.
payoutDate
This timestamp indicates when the seller payout began processing. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z. This field is still returned even if the payout was pending but failed (payoutStatus value shows RETRYABLE_FAILED or TERMINAL_FAILED).
payoutId
The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account.
payoutInstrument
This container provides details about the seller's account that received (or is scheduled to receive) the payout. This container is still returned even if the payout failed.
payoutStatus
This enumeration value indicates the current status of the seller payout. For a successful payout, the value returned will be SUCCEEDED. See the PayoutStatusEnum type for more details on each payout status value.
payoutStatusDescription
This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the payoutStatus field. The following shows what description text might appear based on the different payoutStatus values:
  • INITIATED: Preparing to send
  • SUCCEEDED: Funds sent
  • REVERSED: Waiting to retry : Money rejected by seller's bank
  • RETRYABLE_FAILED: Waiting to retry
  • TERMINAL_FAILED: Payout failed
transactionCount
This integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least 1, since there is at least one order per seller payout.