Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 3.04 KB

File metadata and controls

18 lines (15 loc) · 3.04 KB

# Payout

Properties

Name Type Description Notes
amount \Ebay\Sell\Finances\Model\Amount [optional]
bank_reference string This field contains additional information provided by the bank and passed on by the payment processor; e.g., the manner in which the transaction will appear on the seller's bank statement. The field is returned only when provided by the bank and processor. [optional]
last_attempted_payout_date string 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. [optional]
payout_date string 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). [optional]
payout_id string The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account. [optional]
payout_memo string This field contains information provided by upstream components, based on internal and external commitments. A typical message would contain the expected arrival time of the payout. [optional]
payout_instrument \Ebay\Sell\Finances\Model\PayoutInstrument [optional]
payout_status string 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. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:PayoutStatusEnum&#39;&gt;eBay API documentation</a> [optional]
payout_status_description string 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 [optional]
transaction_count int 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. [optional]

[Back to Model list] [Back to API list] [Back to README]