Skip to main content

GET/payout/{payout_Id}

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method retrieves details on a specific seller payout. The unique identifier 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.

For split-payout cases, which are only available to sellers in mainland China, this method will return the payoutPercentage for the specified payout. This value indicates the current payout percentage allocated to a payment instrument. This method will also return the convertedToCurrency and convertedToValue response fields in CNY value.

Note: In split-payout cases, this method will only return details on an individual payout, also known as a true(actual) payoutid. If a user inputs a payoutReference id as a path parameter, the call will fail and the 404 not found status code will be returned.
For more information on split payouts, see Mainland China Split Payout Playbook.

Input

Resource URI

GET https://apiz.ebay.com/sell/finances/v1/payout/{payout_Id}

This method is supported in Sandbox environment. To access the endpoint, just replace the apiz.ebay.com root URI with apiz.sandbox.ebay.com

URI parameters

ParameterTypeDescription
payout_IdstringThis path parameter is used to specify the unique identifier of the payout being retrieved.

Use the getPayouts method to retrieve payout IDs, or check Seller Hub to get the payout ID.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header identifies the seller's eBay marketplace.

See HTTP request headers for the marketplace ID values.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.

Occurrence: Required

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* Payout */ }

Response fields

Output container/fieldTypeDescription
amountAmount

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.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

amount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

amount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

amount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

amount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

amount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

amount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

bankReferencestring

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.

Occurrence: Conditional

lastAttemptedPayoutDatestring

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

payoutDatestring

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

payoutIdstring

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

payoutInstrumentPayoutInstrument

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.accountLastFourDigitsstring

This value is the last four digits of the account that the seller uses to receive the payout. This may be the last four digits of a bank account, a debit card, or a payment processor account such as Payoneer.

Occurrence: Always

payoutInstrument.instrumentTypestring

This value indicates the type of account that received the payout. The value returned in this field may be:

  • BANK: indicates that the payout was made to a seller's bank account.
  • CARD: indicates that the payout went to a seller's debit card
  • The name of a digital wallet provider or payment processor (e.g., PAYONEER)


Note: Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China.

Occurrence: Always

payoutInstrument.nicknamestring

When instrumentType returns BANK, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.

When instrumentType returns CARD, this value is the debit card network for the debit card that receives the payout.

When instrumentType returns a provider of digital wallet or payment processing services, the value returned is the name of the service provider (e.g., PAYONEER).

Note: Card payouts are not currently available for sellers in mainland China.

Occurrence: Always

payoutInstrument.payoutPercentagestring

This value indicates the current payout percentage allocated to a payout instrument. For example, 50 indicates that 50% of the payout goes to the instrument.

This field will be returned even when 100% of the payout funds are going to one payout instrument.

This field is only returned to sellers in mainland China.

Occurrence: Conditional

payoutMemostring

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.

Occurrence: Conditional

payoutReferencestring

This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout id(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account.

Note: Split-payout functionality will only be available to mainland China sellers.

Occurrence: Conditional

payoutStatusPayoutStatusEnum

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

payoutStatusDescriptionstring

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

Occurrence: Always

totalAmountAmount

This container indicates the sum of a seller's net payout amount plus the EXPRESS_PAYOUT_FEE charged by eBay. The is expressed as a numeric value and the currency used.

Occurrence: Conditional

totalAmount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalAmount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalAmount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

totalAmount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalAmount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

totalFeeAmount

This container indicates the amount of the EXPRESS_PAYOUT_FEE charged by eBay when a seller requests payout to a debit card. The fee is expressed as a numeric value and the currency used.

Occurrence: Conditional

totalFee.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFee.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFee.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalFee.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalFee.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

totalFee.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFee.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

totalFeeDetailsarray of Fee

This array indicates all payout fees associated with a payout, including the fee type, amount, value, and currency.

Occurrence: Conditional

totalFeeDetails.amountAmount

The amount of the fee.

Occurrence: Conditional

totalFeeDetails.amount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFeeDetails.amount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFeeDetails.amount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalFeeDetails.amount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

totalFeeDetails.amount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

totalFeeDetails.amount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

totalFeeDetails.amount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

totalFeeDetails.feeJurisdictionFeeJurisdiction

Indicates the specific jurisdiction for the fee that has been deducted from the seller payout.

Occurrence: Conditional

totalFeeDetails.feeJurisdiction.regionNamestring

String value that indicates the name of the region to which a region-specific fee applies.

The set of valid regionName values that may be returned is determined by the regionType value.

Note: Currently, supported regionName values that may be returned are standard two-character country or state codes.

Typical examples include:

  • MX [Mexico]
  • IN [India]
  • US [United States]
  • CA [California]
  • VT [Vermont]
  • ME [Maine]

Occurrence: Conditional

totalFeeDetails.feeJurisdiction.regionTypeRegionTypeEnum

The enumeration value returned here indicates the type of region that is collecting the corresponding fee.

Occurrence: Conditional

totalFeeDetails.feeMemostring

A description of the fee that was deducted from the seller payout.

Occurrence: Conditional

totalFeeDetails.feeTypeFeeTypeEnum

The enumeration value returned here indicates the type of fee that was deducted from the seller payout.

Occurrence: Conditional

transactionCountinteger

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.

For split payouts, each of the two sibling payouts would be considered its own transaction. Because of this, if a seller had a payout for one order, but split the order between two accounts, the value would be 2 instead of 1.

Note: Split-payout functionality is only applicable to mainland China sellers.

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.

StatusMeaning
200Success
404Not found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
135000API_FINANCESAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
135001API_FINANCESREQUESTThe payout id was not found.

Warnings

This call has no 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.

GEThttps://apiz.ebay.com/sell/finances/v1/payout/5*****6

Output

A successful call returns details of the specified seller payout.

Sample 2: Get a Seller Payout for a True(Actual) Payout With Amount in CNY

This sample retrieves a seller payout corresponding to the provided payout ID. In this sample, the seller is in mainland China and the payout returned is a true (actual) payout with the amount in CNY.

Input

The payout ID is passed in at the end of the call URI.

GEThttps://apiz.ebay.com/sell/finances/v1/payout/5*****7

Output

A successful call returns details of the specified seller payout. As shown below, the converted value and currency are returned in CNY. The payout percentage associated with the instrument is also returned.