The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub.
Resource URI (production)
HTTP request headers
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
|amount||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. |
|amount.currency||CurrencyCodeEnum||A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container. |
Default: The currency of the authenticated user's country.
|amount.value||string||The monetary amount, in the currency specified by the currency field. This field is always returned with the amount container. |
|lastAttemptedPayoutDate||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 |
|payoutDate||string||This timestamp indicates when the seller payout began processing. The following format is used: |
|payoutId||string||The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account. |
|payoutInstrument||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. |
|payoutInstrument.accountLastFourDigits||string||This string value is the last four digits of the seller's account number. |
|payoutInstrument.instrumentType||string||This string value indicates the type of account that received the payout. At this time, seller payouts can only be distributed to bank acounts, so the string value returned in this field will always be |
|payoutInstrument.nickname||string||This string value is a seller-provided nickname that the seller uses to represent the bank account. |
|payoutStatus||PayoutStatusEnum||This enumeration value indicates the current status of the seller payout. For a successful payout, the value returned will be |
|payoutStatusDescription||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:|
|transactionCount||integer||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 |
For more on errors, plus the codes of other common errors, see Handling errors.
|135000||API_FINANCES||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|135001||API_FINANCES||REQUEST||The payout id was not found.|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.