src/Sell/Finances/V1/docs/Model/Payout.md
# # Payout
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) | | [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 <strong>payoutStatus</strong> value shows <code>RETRYABLE_FAILED</code> or <code>TERMINAL_FAILED</code>. A seller can filter on the <b>lastAttemptedPayoutDate</b> in a <b>getPayouts</b> request. | [optional]
**payout_date** | **string** | This timestamp indicates when the seller payout began processing. The following format is used: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. For example, <code>2015-08-04T19:09:02.768Z</code>. This field is still returned even if the payout was pending but failed (<strong>payoutStatus</strong> value shows <code>RETRYABLE_FAILED</code> or <code>TERMINAL_FAILED</code>). | [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_instrument** | [**\TNT\Ebay\Sell\Finances\V1\Model\PayoutInstrument**](PayoutInstrument.md) | | [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_status** | **string** | This enumeration value indicates the current status of the seller payout. For a successful payout, the value returned will be <code>SUCCEEDED</code>. See the <strong>PayoutStatusEnum</strong> 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'>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 <strong>payoutStatus</strong> field. The following shows what description text might appear based on the different <strong>payoutStatus</strong> values:<ul><li><code>INITIATED</code>: <em>Preparing to send</em></li><li><code>SUCCEEDED</code>: <em>Funds sent</em></li><li><code>REVERSED</code>: <em>Waiting to retry : Money rejected by seller's bank</em></li><li><code>RETRYABLE_FAILED</code>: <em>Waiting to retry</em></li><li><code>TERMINAL_FAILED</code>: <em>Payout failed</em></li></ul> | [optional]
**total_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) | | [optional]
**total_fee** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) | | [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 <code>1</code>, since there is at least one order per seller payout. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)