GET
/payout/{payout_Id}
This method retrieves details on a specific seller payout. The unique identfier of the payout is passed in as a path parameter at the end of the call URI.
The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub.
The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub.
Input
Resource URI (production)
GET https://apiz.ebay.com/sell/finances/v1/payout/{payout_Id}
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
OAuth scope
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):
https://api.ebay.com/oauth/api_scope/sell.finances
See OAuth access tokens for more information.
Output
| Output container/field | Type | Description |
|---|---|---|
| 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. Occurrence: Always |
| 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. Occurrence: Conditional |
| amount.value | string | The monetary amount, in the currency specified by the currency field. This field is always returned with the amount container. Occurrence: Conditional |
| 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 RETRYABLE_FAILED or TERMINAL_FAILED. A seller can filter on the lastAttemptedPayoutDate in a getPayouts request. Occurrence: Conditional |
| payoutDate | 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). Occurrence: Always |
| 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. Occurrence: Always |
| 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. Occurrence: Always |
| payoutInstrument.accountLastFourDigits | string | This string value is the last four digits of the seller's account number. Occurrence: Always |
| 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 BankAccount. Occurrence: Always |
| payoutInstrument.nickname | string | This string value is a seller-provided nickname that the seller uses to represent the bank account. Occurrence: Always |
| payoutStatus | PayoutStatusEnum | 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. Occurrence: Always |
| 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:
Occurrence: Always |
| 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 1, since there is at least one order per seller payout. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 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. |
Warnings
Samples
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.
Sample 1: Get a Seller Payout
This sample retrieves a seller payout corresponding to the provided payout ID.
Input
The payout ID is passed in at the end of the call URI.
GET
https://apiz.ebay.com/sell/finances/v1/payout/5000254584
Output
A successful call returns details of the specified seller payout.