openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Payout API description: The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.9.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /sell/account/v1 tags: - name: Payout paths: /payout/{payout_Id}: get: tags: - Payout description: '

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.' operationId: getPayout parameters: - name: X-EBAY-C-MARKETPLACE-ID in: header description: This 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. required: true schema: type: string - name: payout_Id in: path description: 'This 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. ' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Payout' '400': description: Bad Request '404': description: Not found x-response-codes: errors: '135001': domain: API_FINANCES category: REQUEST description: The payout id was not found. '500': description: Internal Server Error x-response-codes: errors: '135000': domain: API_FINANCES category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.finances /payout: get: tags: - Payout description: '

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 is used to retrieve the details of one or more seller payouts. By using the filter query parameter, users can retrieve payouts processed within a specific date range, and/or they can retrieve payouts in a specific state.

There are also pagination and sort query parameters that allow users to control the payouts that are returned in the response.

If no payouts match the input criteria, an empty payload is returned.

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 payout instrument. This method will also return the convertedToCurrency and convertedTo response fields set to CNY value and the payoutReference, the unique identifier reference (not true payout).

By using the filter query parameter, users can retrieve the two true(actual) payouts associated with a payoutReference.

Note: For more information on split payouts, see Mainland China Split Payout Playbook. ' operationId: getPayouts parameters: - name: X-EBAY-C-MARKETPLACE-ID in: header description: This 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. required: true schema: type: string - name: filter in: query description: 'The filter types that can be used here are discussed below. If none of these filters are used, all recent payouts in all states are returned:

If both the payoutDate and payoutStatus filters are used, payouts must satisfy both criteria to be returned. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' required: false schema: type: string - name: limit in: query description: The number of payouts to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the method retrieves payouts 11 thru 20 from the result set.

Note: This feature employs a zero-based list, where the first payout in the results set has an offset value of 0.

Maximum: 200
Default: 20 required: false schema: type: string - name: offset in: query description: This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the method retrieves payouts 31 thru 40 from the resulting collection of payouts.

Note: This feature employs a zero-based list, where the first payout in the results set has an offset value of 0.

Default: 0 (zero) required: false schema: type: string - name: sort in: query description: By default, payouts or failed payouts that match the input criteria are sorted in descending order according to the payout date/last attempted payout date (i.e., most recent payouts returned first).

To view payouts in ascending order instead (i.e., oldest payouts/attempted payouts first,) you would include the sort query parameter, and then set the value of its field parameter to payoutDate or lastAttemptedPayoutDate (if searching for failed, retryable payouts). Below is the proper syntax to use if filtering by a payout date range in ascending order:

https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]&sort=payoutDate

Payouts can only be sorted according to payout date, and can not be sorted by payout status. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:SortField required: false schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Payouts' '204': description: No Content '400': description: Bad Request x-response-codes: errors: '135002': domain: API_FINANCES category: REQUEST description: The value of payout status filter is invalid. '135003': domain: API_FINANCES category: REQUEST description: The value of pagination is invalid. '135004': domain: API_FINANCES category: REQUEST description: The value of payout date filter is invalid. '135005': domain: API_FINANCES category: REQUEST description: The value of sorting is invalid. '500': description: Internal Server Error x-response-codes: errors: '135000': domain: API_FINANCES category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.finances /payout_summary: get: tags: - Payout description: '

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 is used to retrieve cumulative values for payouts in a particular state, or all states. The metadata in the response includes total payouts, the total number of monetary transactions (sales, refunds, credits) associated with those payouts, and the total dollar value of all payouts.

If the filter query parameter is used to filter by payout status, only one payout status value may be used. If the filter query parameter is not used to filter by a specific payout status, cumulative values for payouts in all states are returned.

The user can also use the filter query parameter to specify a date range, and then only payouts that were processed within that date range are considered.' operationId: getPayoutSummary parameters: - name: X-EBAY-C-MARKETPLACE-ID in: header description: This 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. required: true schema: type: string - name: filter in: query description: 'The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect all previous payouts in all states:

If both the payoutDate and payoutStatus filters are used, only the payouts that satisfy both criteria are considered in the results. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' required: false schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayoutSummaryResponse' '400': description: Bad Request x-response-codes: errors: '135002': domain: API_FINANCES category: REQUEST description: The value of payout status filter is invalid '135004': domain: API_FINANCES category: REQUEST description: The value of payout date filter is invalid '500': description: Internal Server Error x-response-codes: errors: '135000': domain: API_FINANCES category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.finances components: schemas: PayoutInstrument: type: object properties: accountLastFourDigits: type: string description: 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. instrumentType: type: string description: 'This value indicates the type of account that received the payout. The value returned in this field may be:


Note: Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China.' nickname: type: string description: 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. payoutPercentage: type: string description: 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. description: This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts. Payouts: type: object properties: href: type: string description: The URI of the getPayouts call request that produced the current page of the result set. limit: type: integer description: The maximum number of payouts that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20.

Note: If this is the last or only page of the result set, the page may contain fewer payouts than the limit value. To determine the number of pages in a result set, divide the total value (total number of payouts matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total payouts) and the limit value was 50 (show 50 payouts per page), the total number of pages in the result set is three, so the seller would have to make three separate getPayouts calls to view all payouts matching the input criteria.

Maximum: 200
Default: 20 format: int32 next: type: string description: The getPayouts call URI to use if you wish to view the next page of the result set.

This field is only returned if there is a next page of results to view based on the current input criteria. offset: type: integer description: This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the call retrieves payouts 31 thru 40 from the resulting collection of payouts.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

Default: 0 (zero) format: int32 payouts: type: array description: An array of one or more payouts that match the input criteria. Details for each payout include the unique identifier of the payout, the status of the payout, the amount of the payout, and the number of monetary transactions associated with the payout. items: $ref: '#/components/schemas/Payout' prev: type: string description: The getPayouts call URI to use if you wish to view the previous page of the result set.

This field is only returned if there is a previous page of results to view based on the current input criteria. total: type: integer description: This integer value is the total number of payouts in the results set based on the current input criteria. Based on the total number of payouts that match the criteria, and on the limit and offset values, there may be additional pages in the results set. format: int32 description: This type is the base response type of the getPayouts method, and contains an array of one or more payouts (that match the input criteria), the total count of payouts in the response, and various pagination data for the results set. Amount: type: object properties: convertedFromCurrency: type: string description: 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. For implementation help, refer to eBay API documentation convertedFromValue: type: string description: 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. convertedToCurrency: type: string description: 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. For implementation help, refer to eBay API documentation convertedToValue: type: string description: 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. currency: type: string description: '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. For implementation help, refer to eBay API documentation' exchangeRate: type: string description: 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. value: type: string description: The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. description: This type is used to express the dollar value and currency used for any transaction retrieved with the Finances API, including an order total, a seller payout, a buyer refund, or a seller credit. PayoutSummaryResponse: type: object properties: amount: description: This container shows the total value (and currency type used) of the seller payouts that match the input criteria. This field is not returned if there are no payouts that match the input criteria. $ref: '#/components/schemas/Amount' payoutCount: type: integer description: This integer value indicates the total count of payouts to the seller that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0). format: int32 transactionCount: type: integer description: This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0). If there is at least one payout that matches the input criteria, the value in this field will be at least 1. format: int32 description: This type is the base response type of the getPayoutSummary method, and contains the total count of seller payouts (that match the input criteria), the total count of monetary transactions (order payment, buyer refunds, or seller credits) associated with those payouts, and the total value of those seller payouts. Payout: type: object properties: amount: description: 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. $ref: '#/components/schemas/Amount' bankReference: type: string description: 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. lastAttemptedPayoutDate: type: string description: 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. payoutDate: type: string description: '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).' payoutId: type: string description: The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account. payoutInstrument: description: 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. $ref: '#/components/schemas/PayoutInstrument' payoutMemo: type: string description: 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. payoutReference: type: string description: '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.' payoutStatus: type: string description: 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 eBay API documentation payoutStatusDescription: type: string description: '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:' totalAmount: description: 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. $ref: '#/components/schemas/Amount' totalFee: description: 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. $ref: '#/components/schemas/Amount' totalFeeDetails: type: array description: This array indicates all payout fees associated with a payout, including the fee type, amount, value, and currency. items: $ref: '#/components/schemas/Fee' transactionCount: type: integer description: '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. ' format: int32 description: This type is used to express the details of one seller payout that is returned with the getPayout or getPayouts methods. Fee: type: object properties: amount: description: The amount of the fee. $ref: '#/components/schemas/Amount' feeJurisdiction: description: Indicates the specific jurisdiction for the fee that has been deducted from the seller payout. $ref: '#/components/schemas/FeeJurisdiction' feeMemo: type: string description: A description of the fee that was deducted from the seller payout. feeType: type: string description: The enumeration value returned here indicates the type of fee that was deducted from the seller payout. For implementation help, refer to eBay API documentation description: This type is used to display fees that are automatically deducted from seller payouts. FeeJurisdiction: type: object properties: regionName: type: string description: 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: regionType: type: string description: The enumeration value returned here indicates the type of region that is collecting the corresponding fee. For implementation help, refer to eBay API documentation description: This container returns jurisdiction information about region-specific fees that are charged to sellers. securitySchemes: api_auth: type: oauth2 description: The security definitions for this API. Please check individual operations for applicable scopes. flows: authorizationCode: authorizationUrl: https://auth.ebay.com/oauth2/authorize tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings