--- openapi: "3.0.0" info: title: "Finances API" description: "This API is used to retrieve seller payouts and monetary transaction\ \ details related to those payouts." contact: name: "eBay Inc," license: name: "eBay API License Agreement" url: "https://developer.ebay.com/join/api-license-agreement" version: "v1.18.0" servers: - url: "https://apiz.ebay.com{basePath}" description: "Production" variables: basePath: default: "/sell/finances/v1" - url: "https://api.ebay.com{basePath}" description: "Production" variables: basePath: default: "/sell/finances/v1" 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.

Note: The Finances API does not support\ \ Team Access. Financial information, such as payouts\ \ or transactions, is only returned for the user that makes the call. You\ \ cannot use any of the methods in this API to return financial information\ \ for another user.
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" "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." "404": description: "Not found" x-response-codes: errors: 135001: domain: "API_FINANCES" category: "REQUEST" description: "The payout id was not found." security: - api_auth: - "https://api.ebay.com/oauth/api_scope/sell.finances" /payout: get: tags: - "payout" description: "

Note: The Finances API does not support\ \ Team Access. Financial information, such as payouts\ \ or transactions, is only returned for the user that makes the call. You\ \ cannot use any of the methods in this API to return financial information\ \ for another user.
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.

Note:\ \ Only payouts less than 5 years in the past can be retrieved." 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 payouts in all states from within\ \ the last five years are returned:

payoutDate: search\ \ for payouts within a specific range of dates. The date format to use is\ \ YYYY-MM-DDTHH:MM:SS.SSSZ. Below is the proper syntax to use\ \ if filtering by a date range:

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

Only\ \ payouts from the last five years can be retrieved, so make sure the starting\ \ date is less than five years in the past from the present time. Also,\ \ the maximum date range that can be specified through this date filter\ \ is 36 months, so make sure your specified date range is no more than 36\ \ months.
lastAttemptedPayoutDate: search for attempted payouts\ \ that failed within a specific range of dates. In order to use this filter,\ \ the payoutStatus filter must also be used and its value must be\ \ set to RETRYABLE_FAILED. The date format to use is YYYY-MM-DDTHH:MM:SS.SSSZ.\ \ The same syntax and requirements applicable to the payoutDate filter\ \ also apply to the lastAttemptedPayoutDate filter.

This\ \ filter is only applicable (and will return results) if one or more seller\ \ payouts have failed, but are retryable.
payoutStatus:\ \ search for payouts in a particular state. Only one payout state can be\ \ specified with this filter. For supported payoutStatus values,\ \ see PayoutStatusEnum.

Below is the proper syntax to use\ \ if filtering by payout status:

https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutStatus:{SUCCEEDED}
payoutReference:\ \ returns the two true (actual) payouts associated with the payoutReference\ \ id. This parameter can support up to 200 payoutReference inputs.\ \ This filter is only supported for mainland China sellers. Below\ \ is the proper syntax to use if filtering by a specific payoutReference:

https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutReference:{5********3}

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.

To avoid poor response time, use offset values\ \ of less than 5000.

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" "400": description: "Bad Request" x-response-codes: errors: 135014: domain: "API_FINANCES" category: "REQUEST" description: "The supplied date range is invalid, as the date range\ \ cannot exceed 36 months. Please update the date range and resubmit\ \ the request." 135013: domain: "API_FINANCES" category: "REQUEST" description: "The supplied start date is invalid, as payouts older\ \ than five years cannot be retrieved. Please update the start date\ \ and resubmit the request." 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." "204": description: "No Content" security: - api_auth: - "https://api.ebay.com/oauth/api_scope/sell.finances" /payout_summary: get: tags: - "payout" description: "

payoutDate:\ \ consider payouts processed within a specific range of dates. The date\ \ format to use is YYYY-MM-DDTHH:MM:SS.SSSZ. Below is the proper\ \ syntax to use if filtering by a date range:

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

Only\ \ payouts from the last five years can be retrieved, so make sure the starting\ \ date is less than five years in the past from the present time. Also,\ \ the maximum date range that can be specified through this date filter\ \ is 36 months, so make sure your specified date range is no more than 36\ \ months.
payoutStatus: consider only the payouts in a particular\ \ state. Only one payout state can be specified with this filter. For supported\ \ payoutStatus values, see PayoutStatusEnum.

Below is the proper syntax\ \ to use if filtering by payout status:

https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutStatus:{SUCCEEDED}

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: 135014: domain: "API_FINANCES" category: "REQUEST" description: "The supplied date range is invalid, as the date range\ \ cannot exceed 36 months. Please update the date range and resubmit\ \ the request." 135013: domain: "API_FINANCES" category: "REQUEST" description: "The supplied start date is invalid, as payouts older\ \ than five years cannot be retrieved. Please update the start date\ \ and resubmit the request." 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" /seller_funds_summary: get: tags: - "seller_funds_summary" description: "

SALE transactions\ \ for August 15, 2022;
RETURN transactions for the month\ \ of January, 2021;
Transactions currently in a transactionStatus\ \ equal to FUNDS_ON_HOLD.

Refer to the filter field for additional information about each filter and its\ \ use.

Pagination and sort query parameters are also provided that\ \ allow users to further control how monetary transactions are displayed in\ \ the response.

If no monetary transactions match the input criteria,\ \ an http status code of 204 No Content is returned with no response\ \ payload.

Note: Only monetary transactions that have occurred\ \ within the last five years can be retrieved." operationId: "getTransactions" 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: "Numerous filters are available for the getTransactions\ \ method, and these filters are discussed below. One or more of these filter\ \ types can be used. If none of these filters are used, all monetary transactions\ \ occurring within the last five years are returned:

transactionDate:\ \ search for monetary transactions that occurred within a specific range\ \ of dates.

Note: All\ \ dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ)\ \ and should be adjusted accordingly for the local timezone of the user.
Below\ \ is the proper syntax to use if filtering by a date range:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]

Only\ \ payouts from the last five years can be retrieved, so make sure the starting\ \ date is less than five years in the past from the present time. Also,\ \ the maximum date range that can be specified through this date filter\ \ is 36 months, so make sure your specified date range is no more than 36\ \ months.
transactionType: search for a specific type of\ \ monetary transaction. For supported transactionType values, see\ \ TransactionTypeEnum.

Below is the proper syntax to\ \ use if filtering by a monetary transaction type:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}
transactionStatus:\ \ this filter type is only applicable for sales orders, and allows the user\ \ to filter seller payouts in a particular state. For supported transactionStatus\ \ values, see TransactionStatusEnum.

Below is the proper\ \ syntax to use if filtering by transaction status:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}
buyerUsername:\ \ the eBay username or user ID of the buyer involved in the monetary transaction.\ \ Only monetary transactions involving this buyer are returned. Below is\ \ the proper syntax to use if filtering by a specific eBay buyer:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}\ \
payoutId: the unique identifier of a seller payout. This\ \ value is auto-generated by eBay once the seller payout is set to be processed.\ \ Only monetary transactions involving this Payout ID are returned. Below\ \ is the proper syntax to use if filtering by a specific Payout ID:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8}\ \
transactionId: use this field transactionId and\ \ also transactionType to filter for a unique identifier of a monetary\ \ transaction, or an error will occur. For a sales order, the orderId\ \ filter should be used instead. Only the monetary transaction defined by\ \ the identifier is returned.

Note:\ \ This filter cannot be used alone; the transactionType must also\ \ be specified when filtering by transaction ID.
Below is the\ \ proper syntax to use if filtering by a specific transaction ID:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}\ \
orderId: the unique identifier of a sales order. Only\ \ monetary transaction(s) associated with this orderId value are\ \ returned.

For any other monetary transaction, the transactionId\ \ filter should be used instead.

Below is the proper syntax to use\ \ if filtering by a specific order ID:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3}\ \
payoutReference: returns the monetary transactions associated\ \ with the payoutReference. By using this ID as a filter parameter,\ \ the user will be able to track all monetary transactions associated with\ \ both sibling payouts, including sales and refunds, if any. This filter\ \ is only supported for sellers in Mainland China. Below is the proper\ \ syntax to use if filtering by payoutReference:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutReference:{5*******3}

\ \ 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 monetary transactions 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 monetary transactions 11 thru 20 from the result\ \ set.

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

Maximum: 1000
\ \ Default: 20" required: false schema: type: "string" - name: "offset" in: "query" description: "This integer value indicates the actual position that the first\ \ monetary transaction returned on the current page has in the results set.\ \ So, if you wanted to view the 11th monetary transaction 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 transactions\ \ 31 thru 40 from the resulting collection of transactions.

To\ \ avoid poor response time, use offset values of less than 5000.\ \

Note: This feature\ \ employs a zero-based list, where the first item in the list has an offset\ \ of 0.
Default: 0 (zero)" required: false schema: type: "string" - name: "sort" in: "query" description: "By default, monetary transactions that match the input criteria\ \ are sorted in descending order according to the transaction date (i.e,\ \ most recent transactions returned first).

To view transactions\ \ in ascending order instead (i.e., oldest transactions first), you would\ \ include the sort query parameter and set its value to transactionDate.\ \ Below is the proper syntax to use if filtering by a transaction date range\ \ in ascending order:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2023-10-01T00:00:01.000Z..2023-10-12T00:00:01.000Z]&sort=transactionDate

Transactions\ \ can only be sorted according to transaction date. 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/Transactions" "400": description: "Bad Request" x-response-codes: errors: 135008: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction date filter is invalid." 135009: domain: "API_FINANCES" category: "REQUEST" description: "Transaction type filter is missing." 135015: domain: "API_FINANCES" category: "REQUEST" description: "The supplied start date is invalid, as transactions\ \ older than five years cannot be retrieved. Please update the start\ \ date and resubmit the request." 135003: domain: "API_FINANCES" category: "REQUEST" description: "The value of pagination is invalid." 135016: domain: "API_FINANCES" category: "REQUEST" description: "The supplied date range is invalid, as the date range\ \ cannot exceed 36 months. Please update the date range and resubmit\ \ the request." 135006: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction type filter is invalid." 135007: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction status 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." "204": description: "No Content" security: - api_auth: - "https://api.ebay.com/oauth/api_scope/sell.finances" /transaction_summary: get: tags: - "transaction" description: "

<
Note: The Finances API does not support\ \ Team Access. Financial information, such as payouts\ \ or transactions, is only returned for the user that makes the call. You\ \ cannot use any of the methods in this API to return financial information\ \ for another user.
The getTransactionSummary method retrieves\ \ cumulative information for monetary transactions. If applicable, the number\ \ of payments with a transactionStatus equal to FUNDS_ON_HOLD\ \ and the total monetary amount of these on-hold payments are also returned.

Note: For a complete list of transaction types,\ \ refer to TransactionTypeEnum.
Refer to the filter field for additional information about\ \ each filter and its use.

Note: Unless\ \ a transactionType filter is used to retrieve a specific type\ \ of transaction (e.g., SALE, REFUND, etc.,) the\ \ creditCount and creditAmount response fields both include order sales and seller\ \ credits information. That is, the count and value fields\ \ do not distinguish between these two types monetary transactions.\ \

Note: getTransactionSummary will only return data on transactions\ \ that occurred less than five years in the past." operationId: "getTransactionSummary" 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: "Numerous filters are available for the getTransactionSummary\ \ method, and these filters are discussed below. One or more of these filter\ \ types can be used. The transactionStatus filter must be used. All\ \ other filters are optional.

transactionStatus: the data\ \ returned in the response pertains to the sales, payouts, and transfer\ \ status set. For supported transactionStatus values, see TransactionStatusEnum.

Below is the proper syntax to use\ \ when setting up the transactionStatus filter:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}
transactionDate:\ \ only consider monetary transactions that occurred within a specific range\ \ of dates.

Note: All\ \ dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ)\ \ and should be adjusted accordingly for the local timezone of the user.

Below\ \ is the proper syntax to use if filtering by a date range:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]

Note:Only\ \ monetary transactions from the last five years can be retrieved, so make\ \ sure the starting date is less than five years in the past from the present\ \ time. Also, the maximum date range that can be specified through this\ \ date filter is 36 months, so make sure your specified date range is no\ \ more than 36 months.
transactionType: only consider a\ \ specific type of monetary transaction. For supported transactionType\ \ values, see TransactionTypeEnum.

Below is the proper\ \ syntax to use if filtering by a monetary transaction type:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}
buyerUsername:\ \ only consider monetary transactions involving a specific buyer (specified\ \ with the buyer's eBay username or user ID). Below is the proper syntax\ \ to use if filtering by a specific eBay buyer:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}\ \
payoutId: only consider monetary transactions related\ \ to a specific seller payout (identified with a Payout ID). This value\ \ is auto-generated by eBay once the seller payout is set to be processed.\ \ Below is the proper syntax to use if filtering by a specific Payout ID:\ \

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8}\ \
transactionId: the unique identifier of a monetary transaction.\ \ For a sales order, the orderId filter should be used instead. Only\ \ the monetary transaction(s) associated with this transactionId\ \ value are returned.

Note:\ \ This filter cannot be used alone; the transactionType must also\ \ be specified when filtering by transaction ID.

Below is\ \ the proper syntax to use if filtering by a specific transaction ID:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}\ \
orderId: the unique identifier of a sales order. For any\ \ other monetary transaction, the transactionId filter should be\ \ used instead. Only the monetary transaction(s) associated with this orderId\ \ value are returned. Below is the proper syntax to use if filtering by\ \ a specific order ID:

https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-0***0-3***3}\ \

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/TransactionSummaryResponse" "400": description: "Bad Request" x-response-codes: errors: 135011: domain: "API_FINANCES" category: "REQUEST" description: "Transaction status filter is mandatory." 135008: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction date filter is invalid." 135009: domain: "API_FINANCES" category: "REQUEST" description: "Transaction type filter is missing." 135015: domain: "API_FINANCES" category: "REQUEST" description: "The supplied start date is invalid, as transactions\ \ older than five years cannot be retrieved. Please update the start\ \ date and resubmit the request." 135016: domain: "API_FINANCES" category: "REQUEST" description: "The supplied date range is invalid, as the date range\ \ cannot exceed 36 months. Please update the date range and resubmit\ \ the request." 135006: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction type filter is invalid." 135007: domain: "API_FINANCES" category: "REQUEST" description: "The value of transaction status 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" /transfer/{transfer_Id}: get: tags: - "transfer" description: "

Note: The Finances API does not support\ \ Team Access. Financial information, such as payouts\ \ or transactions, is only returned for the user that makes the call. You\ \ cannot use any of the methods in this API to return financial information\ \ for another user.
This method retrieves detailed information regarding\ \ a TRANSFER transaction type. A TRANSFER is a \ \ monetary transaction type that involves a seller transferring money to eBay\ \ for reimbursement of one or more charges. For example, when a seller reimburses\ \ eBay for a buyer refund.

If an ID is passed into the URI that is\ \ an identifier for another transaction type, this call will return an http\ \ status code of 404 Not found." operationId: "getTransfer" 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: "transfer_Id" in: "path" description: "This path parameter is used to specify the unique identifier\ \ of the TRANSFER transaction type you wish to retrieve.

Use\ \ the getTransactions method to retrieve this value by\ \ setting the transactionType filter to TRANSFER. The\ \ transfer_id value will then be returned in the transaction_id\ \ field of the response." required: true schema: type: "string" responses: "200": description: "Success." content: application/json: schema: $ref: "#/components/schemas/Transfer" "400": description: "Bad Request" "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." "404": description: "Not found." x-response-codes: errors: 135012: domain: "API_FINANCES" category: "REQUEST" description: "The transfer id was not found." security: - api_auth: - "https://api.ebay.com/oauth/api_scope/sell.finances" /billing_activity: get: tags: - "billing_activity" description: "

activityId: If this filter is used, only information\ \ on a specific billing activity is returned. The billingTransactionId returned in the response can be used as the activityId.
listingId:\ \ If this filter is used, only billing activity associated with the specified\ \ listing is returned.
orderId: If this filter is used, only\ \ billing activity associated with the specified order is returned.
transactionDate:\ \ If a date range filter is used, only billing activity that occurred within\ \ the specified date range is returned. The starting date cannot be set\ \ back further than 120 days in the past. Use UTC date values in the following\ \ order: [start..end]

Examples
IDs:
filter=activityID:{12**56}

Date\ \ range:
filter=transactionDate:[2025-10-01T00:00:00Z..2025-10-31T23:59:59Z]\ \ 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: "Sets the maximum number of records to return per page of data.

Use\ \ this parameter in conjunction with the offset parameter to control\ \ the pagination of the output. For example, with offset set to 20\ \ and limit set to 10, the call retrieves entries 21 through\ \ 30 from the result set.

Although this field is optional, if omitted\ \ the default value of 100 is used.

Minimum:\ \ 1
Maximum: 200
Default:\ \ 100" required: false schema: type: "string" - name: "offset" in: "query" description: "Specifies the number of records to skip in the result set. This\ \ is used with the limit field to control the pagination of\ \ the output. For example:

If offset is 0\ \ and limit is 10, the method will retrieve records\ \ 1-10 from the list of records returned
If offset is 10\ \ and limit is 10, the method will retrieve records\ \ 11-20 from the list of records returned.

If this parameter\ \ is not set, its value defaults to 0 which returns the first\ \ page of records.

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

Default:\ \ 0 (zero, returns the first page)

" required: false schema: type: "string" - name: "sort" in: "query" description: "By default, transactions that match the input criteria are sorted\ \ in descending order according to the transaction date (most recent transactions\ \ returned first).

To view transactions in ascending order instead\ \ (oldest transactions first), include the sort query parameter and\ \ set its value to sort=transactionDate. For example (ascending\ \ order):

filter=transactionDate:[2025-11-01T00:00:01.000Z..2025-11-12T00:00:01.000Z]&sort=transactionDate

Transactions\ \ can only be sorted according to transaction date. If omitted, defaults\ \ to descending order (most recent transactions returned first). 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: "OK" content: application/json: schema: $ref: "#/components/schemas/BillingActivityResponse" "400": description: "Bad Request" x-response-codes: errors: 135025: domain: "API_FINANCES" category: "REQUEST" description: "Invalid date range: the end date occurs before the start\ \ date." 135015: domain: "API_FINANCES" category: "REQUEST" description: "At least one filter parameter must be used. See documentation\ \ for supported filter types." 135018: domain: "API_FINANCES" category: "REQUEST" description: "Only one filter type can be used at a time." 135019: domain: "API_FINANCES" category: "REQUEST" description: "Invalid date format. Date must be in ISO-8601 format\ \ (e.g., 2024-10-23T00:00:01.000Z)." 135016: domain: "API_FINANCES" category: "REQUEST" description: "Invalid filter format. See documentation for correct\ \ format for each filter type." 135017: domain: "API_FINANCES" category: "REQUEST" description: "Invalid filter type. See documentation for supported\ \ filter types." 135022: domain: "API_FINANCES" category: "REQUEST" description: "Invalid limit value. Limit must be between 1 and 200." 135023: domain: "API_FINANCES" category: "REQUEST" description: "Invalid offset value. If provided, Offset must be 0\ \ or greater." 135020: domain: "API_FINANCES" category: "REQUEST" description: "There is a syntax error in your date_range filter. Please\ \ see documentation for proper syntax." 135005: domain: "API_FINANCES" category: "REQUEST" description: "The sort value is invalid. See documentation for supported\ \ values." 135021: domain: "API_FINANCES" category: "REQUEST" description: "The starting date range cannot be set back further than\ \ 120 days in the past." "500": description: "Internal Server Error" x-response-codes: errors: 135000: domain: "API_FINANCES" category: "REQUEST" 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" servers: - url: "https://api.ebay.com{basePath}" description: "Production" variables: basePath: default: "/sell/finances/v1" components: schemas: 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 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." BalanceAdjustment: type: "object" properties: adjustmentAmount: description: "The seller payout balance amount that will be applied toward\ \ the charges outlined in the charges array." $ref: "#/components/schemas/Amount" adjustmentType: type: "string" description: "The enumeration value returned here indicates if the charge\ \ is a DEBIT or a CREDIT to the seller. Generally,\ \ all transfer transaction types are going to be DEBIT, since\ \ the money is being tranferred from the seller to eBay. For implementation\ \ help, refer to eBay\ \ API documentation" description: "This type is used by the balanceAdjustment container, which\ \ shows the seller payout balance that will be applied toward the charges\ \ outlined in the charges array." BillingActivityLineItem: type: "object" properties: amount: description: "This container shows the amount of the fee or credit. The\ \ value and currency are always returned. If the buyer is in one country\ \ and purchases from an eBay marketplace that uses a different currency,\ \ the response also includes the converted-from and converted-to fields,\ \ along with the exchange rate." $ref: "#/components/schemas/Amount" billingTransactionDate: type: "string" description: "This timestamp indicates the date/time when eBay processed\ \ the transaction." billingTransactionId: type: "string" description: "This field provides a unique identifier of the billing transaction.\ \ If a seller wants to view details on a specific billing transaction,\ \ they can use the actvityId filter and pass in a specific billingTransactionId\ \ value." bookingEntry: type: "string" description: "The value returned in this field will indicate if the billing\ \ transaction is a debit against the seller's account, or a credit. A\ \ debit is much more prevalent than a credit, but sometimes a listing\ \ fee will get reversed and they will get a credit for this fee. Possible\ \ values:

DEBIT
CREDIT

" feeType: type: "string" description: "This field describes the type of fee associated with the transaction.\ \ An example value is FinalValueFeeFixedFeePerOrder." feeTypeDescription: type: "string" description: "This field contains the human-readable description of the\ \ fee type associated with the transaction. For example,

Final Value\
            \ Fee

." listingId: type: "string" description: "The unique identifier of the eBay listing associated with\ \ the billing transaction. This field is returned if the fee is associated\ \ with a listing." orderId: type: "string" description: "The unique identifier of the eBay order associated with the\ \ billing transaction. This field is returned if the fee is associated\ \ with an order." promotionalOffers: type: "array" description: "A list of seller promotional offers applicable for the billing\ \ transaction." items: $ref: "#/components/schemas/DiscountDetail" description: "BillingActivityLineItem" BillingActivityResponse: type: "object" properties: billingActivities: type: "array" description: "A list of billing activity entries that meet the filter criteria.\ \ Billing activity will include fees, credits, and promotional offers\ \ applied to the seller's account." items: $ref: "#/components/schemas/BillingActivityLineItem" count: type: "integer" description: "An integer representing the number of billing activity items\ \ returned in this response page." format: "int32" limit: type: "integer" description: "The value of the limit parameter. This is the maximum\ \ number of line items, as filtered, of billing transactions to return\ \ per page from the result set." format: "int32" next: type: "string" description: "The URI for the next page of results starting with the resource\ \ name. This URI is returned if there is an additional page of results\ \ in the result set." offset: type: "integer" description: "The value of the offset parameter. This field indicates\ \ how many results were skipped in the response. If an offset parameter\ \ was not included in the request, this value will default to 0,\ \ returning the first page of results." format: "int32" prev: type: "string" description: "The URI for the previous page of results starting with the\ \ resource name. This URI is returned if there is a previous page of results\ \ in the result set." total: type: "integer" description: "The total number of billing transactions available that match\ \ the filter criteria.

Note: When the total value exceeds the limit\ \ value, there are multiple pages of results.

" format: "int32" description: "BillingActivityResponse" Buyer: type: "object" properties: username: type: "string" description: "The eBay user ID of the order's buyer.

Note: Effective September 26, 2025, select developers\ \ will no longer receive username data for U.S. users through this field.\ \ Instead, an immutable user ID will be returned in its place. For more\ \ information, please refer to Data Handling Compliance. " description: "This type is used to express details about the buyer associated\ \ with an order. At this time, the only field in this type is the eBay user\ \ ID of the buyer, but more fields may get added at a later date." Charge: type: "object" properties: cancellationId: type: "string" description: "The unique identifier of an order cancellation. This field\ \ is only applicable and returned if the charge is related to an order\ \ cancellation." caseId: type: "string" description: "The unique identifier of a case filed against an order. This\ \ field is only applicable and returned if the charge is related to a\ \ case filed against an order." chargeNetAmount: description: "This container shows the net amount of the charge, which is\ \ the total amount of the charge minus the total amount of fees credited\ \ towards this refund as per eBay policy. It is possible for there to\ \ be multiple charges from multiple orders with one transfer. The net\ \ aggregate amount for all charges found in the charges array can\ \ be found in the transferDetail.totalChargeNetAmount container." $ref: "#/components/schemas/Amount" inquiryId: type: "string" description: "The unique identifier of an Item Not Received (INR) inquiry\ \ filed against an order. This field is only applicable and returned if\ \ the charge is related to has an INR inquiry filed against the order." orderId: type: "string" description: "The unique identifier of the order that is associated with\ \ the charge." paymentDisputeId: type: "string" description: "The unique identifier of a third-party payment dispute filed\ \ against an order. This occurs when the buyer files a dispute against\ \ the order with their payment provider, and then the dispute comes into\ \ eBay's system. This field is only applicable and returned if the charge\ \ is related to a third-party payment dispute filed against an order." refundId: type: "string" description: "The unique identifier of a buyer refund associated with the\ \ charge." returnId: type: "string" description: "The unique identifier of an order return. This field is only\ \ applicable and returned if the charge is related to an order that was\ \ returned by the buyer." description: "This type is used by the charge container, which is an\ \ array of one or more charges related to the transfer." DiscountDetail: type: "object" properties: amount: description: "This container shows the amount of the promotion. The value\ \ and currency are always returned. If the buyer is in one country and\ \ purchases from an eBay marketplace that uses a different currency, the\ \ response also includes the converted-from and converted-to fields, and\ \ the exchange rate." $ref: "#/components/schemas/Amount" offerType: type: "string" description: "The type of promotional discount applied through the activity's\ \ promotional offer amount. Examples include offer types such as\ \ ETRS (eBay Top Rated Seller) and PROMOTION." description: "This container shows the amount of the promotional offer." Error: type: "object" properties: category: type: "string" description: "Identifies the type of erro." domain: type: "string" description: "Name for the primary system where the error occurred. This\ \ is relevant for application errors." errorId: type: "integer" description: "A unique number to identify the error." format: "int32" inputRefIds: type: "array" description: "An array of request elements most closely associated to the\ \ error." items: type: "string" longMessage: type: "string" description: "A more detailed explanation of the error." message: type: "string" description: "Information on how to correct the problem, in the end user's\ \ terms and language where applicable." outputRefIds: type: "array" description: "An array of request elements most closely associated to the\ \ error." items: type: "string" parameters: type: "array" description: "An array of name/value pairs that describe details the error\ \ condition. These are useful when multiple errors are returned." items: $ref: "#/components/schemas/ErrorParameter" subdomain: type: "string" description: "Further helps indicate which subsystem the error is coming\ \ from. System subcategories include: Initialization, Serialization, Security,\ \ Monitoring, Rate Limiting, etc." description: "This type defines the fields that can be returned in an error." ErrorParameter: type: "object" properties: name: type: "string" description: "The object of the error." value: type: "string" description: "The value of the object." 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:

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

" 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." FundingSource: type: "object" properties: brand: type: "string" description: "The brand name of the credit card or the name of the financial\ \ institution that is the source of payment. This field may not be populated\ \ for other funding sources." memo: type: "string" description: "This field provides a note about the funding source. If the\ \ seller's credit card or bank account is the funding source, this field\ \ might contain the last four digits of the credit card or bank account.\ \ This field may also be returned as null." type: type: "string" description: "The string value returned here indicates the funding source.\ \ Possible values include the following:

AVAILABLE_FUNDS:\ \ transfer is funded with seller payout funds
CREDIT_CARD:\ \ transfer is funded with seller's credit card
BANK:\ \ transfer is funded with a direct debit to seller's bank account on file\ \ with eBay
PAY_UPON_INVOICE: eBay will bill the\ \ seller for the transfer on the monthly invoice

" description: "This type provided details on the funding source for the transfer." OrderLineItem: type: "object" properties: donations: type: "array" description: "The list of donations applied to the line item.

Note: Currently, this array is only returned\ \ if the seller chooses to donate a percentage of the sales proceeds to\ \ a charitable organization registered with the eBay for Charity program." items: $ref: "#/components/schemas/Fee" feeBasisAmount: description: "This amount is the order's total amount and equals what the\ \ buyer has paid. This value includes transactions.amount, totalFeeAmount,\ \ eBayCollectedTaxAmount, and shipping charges (if any)." $ref: "#/components/schemas/Amount" lineItemId: type: "string" description: "The unique identifier of an order line item." marketplaceFees: type: "array" description: "An array of all fees accrued for the order line item and deducted\ \ from a seller payout." items: $ref: "#/components/schemas/Fee" description: "This type is used to show the fees and donations that are deducted\ \ from a seller payout for each line item in an order." 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:

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

" 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." PayoutDetails: type: "object" properties: payoutIds: type: "array" description: "This array indicates the list of true(actual) payout ids associated\ \ with a split payout. These values can be used as a path parameter for\ \ the getPayout method to retrieve details on the associated payouts." items: type: "string" 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. This value\ \ can be used by the filter query parameter of the getPayouts\ \ method to get the monetary details of each true(actual) payout associated\ \ with the payoutReference.

Note:Split-payout\ \ functionality will only be available to mainland China sellers." description: "This type provide payout details for a split-payout case. This\ \ type is only applicable for split payouts." 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:

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." 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." 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." 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." Reference: type: "object" properties: referenceId: type: "string" description: "The identifier of the transaction as specified by the referenceType.\ \ For example, with a referenceType of item_id,\ \ the referenceId refers to a unique item. This item\ \ may have several NON_SALE_CHARGE transactions." referenceType: type: "string" description: "An enumeration value that identifies the reference type associated\ \ with the referenceId. For implementation help, refer\ \ to eBay\ \ API documentation" description: "This field is returned for NON_SALE_CHARGE transactions that contain\ \ non-transactional seller fees." SellerFundsSummaryResponse: type: "object" properties: availableFunds: description: "This field represents the total amount of order funds that\ \ are available for a payout, but processing for a seller payout has not\ \ yet begun. If a seller wants to get more details on sales transactions\ \ that have yet to be processed, the seller can use the getTransactions\ \ method, and use the transactionStatus filter with its\ \ value set to FUNDS_AVAILABLE_FOR_PAYOUT.

This container\ \ will return 0.0 with the appropriate payout currency if there are no\ \ funds available to be processed for a payout." $ref: "#/components/schemas/Amount" fundsOnHold: description: "This field represents the total amount of order funds on hold.\ \ Seller payment holds can occur for different reasons. If a seller wants\ \ to get more details on sales transactions where funds are currently\ \ on hold, the seller can use the getTransactions method,\ \ and use the transactionStatus filter with its value\ \ set to FUNDS_ON_HOLD.

This container will return\ \ 0.0 with the appropriate payout currency if there are no seller payment\ \ holds that will eventually be processed for a payout." $ref: "#/components/schemas/Amount" processingFunds: description: "This field represents the total amount of order funds being\ \ prepared and processed for a seller payout. If a seller wants to get\ \ more details on sales transactions that are being processed, the seller\ \ can use the getTransactions method, and use the transactionStatus\ \ filter with its value set to FUNDS_PROCESSING.

This\ \ container will return 0.0 with the appropriate payout currency if there\ \ are no funds available to be processed for a payout." $ref: "#/components/schemas/Amount" totalFunds: description: "This field represents the total amount of order funds still\ \ due to be distributed to the seller through a seller payout. This field\ \ should equal the sum of the amounts returned in the following fields:

processingFunds
availableFunds
fundsOnHold

If\ \ no payout funds are due to the seller, a 204 - No Content\ \ status code will be returned along with an empty payload." $ref: "#/components/schemas/Amount" description: "This type is used by the response payload of the getSellerFundsSummary\ \ method. All of the funds returned in getSellerFundsSummary\ \ are funds that have not yet been paid to the seller through a seller payout.\ \ If there are no funds that are pending, on hold, or being processed for\ \ the seller's account, no response payload is returned, and an http status\ \ code of 204 - No Content is returned instead." Tax: type: "object" properties: taxType: type: "string" description: "The enumeration value returned here indicates the type of\ \ tax. For implementation help, refer to eBay\ \ API documentation" amount: description: "Amount of tax." $ref: "#/components/schemas/Amount" description: "This type is used to return the tax details of a transaction." Transaction: type: "object" properties: amount: description: "This container shows the dollar value and currency type of\ \ the monetary transaction. This field is always returned even when eBay\ \ has yet to initiate a payout for the order." $ref: "#/components/schemas/Amount" bookingEntry: type: "string" description: "The enumeration value returned in this field indicates if\ \ the monetary transaction amount is a (CREDIT) or a (DEBIT)\ \ to the seller's account. Typically, the SALE and CREDIT\ \ transaction types are credits to the seller's account, and the REFUND,\ \ DISPUTE, SHIPPING_LABEL, and TRANSFER\ \ transaction types are debits to the seller's account. For implementation\ \ help, refer to eBay\ \ API documentation" buyer: description: "This is the unique eBay user ID for the buyer who purchased\ \ the order. This field is not returned for TRANSFER monetary\ \ transaction types." $ref: "#/components/schemas/Buyer" eBayCollectedTaxAmount: description: "This is the amount of sales tax that has been collected by\ \ eBay for an order.

Note: Sales\ \ tax applies only to SALE and REFUND transactions\ \ (transactionType)." $ref: "#/components/schemas/Amount" feeJurisdiction: description: "This container stores information about region-specific fees\ \ that are charged to sellers.

This is returned for fees (i.e.,\ \ FeeTypeEnum values,) that are mandated by a seller's governing\ \ jurisdiction.

For example:

INCOME_TAX_WITHHOLDING
TAX_DEDUCTION_AT_SOURCE
VAT_WITHHOLDING

" $ref: "#/components/schemas/FeeJurisdiction" feeType: type: "string" description: "The enumeration value returned in this field indicates the\ \ type of fee that was deducted from the seller payout. For implementation\ \ help, refer to eBay\ \ API documentation" orderId: type: "string" description: "The unique identifier of the eBay order associated with the\ \ monetary transaction." orderLineItems: type: "array" description: "This array either shows the order line item transactional\ \ fees related to a SALE transaction and deducted from the\ \ payout associated with that order, or it shows the transactional fee\ \ credits going back to the seller in the case of a REFUND\ \ transaction.

Note:\ \ In certain circumstances, transactional fees like FINAL_VALUE_FEE\ \ and FINAL_VALUE_FEE_FIXED_PER_ORDER are not deducted from\ \ a seller payout, but instead they are billed to the seller's account\ \ as \"non-sale charges\". When this happens, the SALE transaction\ \ entity will not have these fees under the orderLineItems array,\ \ but they will appear as separate NON_SALE_CHARGE transactions.\ \ When this happens, and you want to see those transactional fees for\ \ the order, one thing you can do is make another call to getTransactions\ \ and filter against the orderId. In the response, you will see\ \ the SALE transaction and the NON_SALE_CHARGE\ \ transactions applied against the order. See Sample 6: Get transactional fees for an order and Sample 10: Get non-sale charges for an order for examples." items: $ref: "#/components/schemas/OrderLineItem" paymentsEntity: type: "string" description: "This string value indicates the entity that is processing\ \ the payment." payoutDetails: description: "This container provides the payout details for a split-payout\ \ case. This container is only returned for split-payout use cases." $ref: "#/components/schemas/PayoutDetails" payoutId: type: "string" description: "The unique identifier of the seller payout associated with\ \ the monetary transaction. This identifier is generated once eBay begins\ \ processing the payout for the corresponding order. This field will not\ \ be returned if eBay has not yet begun processing the payout for an order.

This\ \ value can be used by the filter query parameter to get monetary\ \ transactions associated with the true(actual) payout associated with\ \ the PayoutId.

Note: In\ \ case of a split payout, always pick the first true(actual) payout id. " references: type: "array" description: "This field contains reference information for the transaction\ \ fee. This includes an ID and the type of ID provided (such as item ID)." items: $ref: "#/components/schemas/Reference" salesRecordReference: type: "string" description: "The Sales Record Number associated with a sales order. Sales\ \ Record Numbers are Selling Manager/Selling Manager Pro identifiers that\ \ are created at order checkout.

Note:\ \ For all orders originating after February 1, 2020, a value of 0\ \ will be returned in this field. The Sales Record Number field has also\ \ been removed from Seller Hub. Instead of salesRecordReference,\ \ depend on orderId instead as the identifier of the\ \ order. The salesRecordReference field has been scheduled\ \ for deprecation, and a date for when this field will no longer be returned\ \ at all will be announced soon." taxes: type: "array" description: "This array shows the tax type and amount applicable to the\ \ transaction.

Note: Currently,\ \ this array is only returned for tax charged against a purchased eBay\ \ shipping label." items: $ref: "#/components/schemas/Tax" totalFeeAmount: description: "This amount is the total amount of selling fees paid for order.\ \ A breakdown of fees for each order line item can be found in the orderLineItems\ \ array.

This field is even returned if it is 0.0\ \ (no fees deducted from seller payout)." $ref: "#/components/schemas/Amount" totalFeeBasisAmount: description: "This amount is the total amount for the order before selling\ \ fees are deducted from the seller payout associated with the order." $ref: "#/components/schemas/Amount" transactionDate: type: "string" description: "This timestamp indicates when the monetary transaction (order\ \ purchase, buyer refund, seller credit) occurred. The following (UTC)\ \ format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example,\ \ 2015-08-04T19:09:02.768Z." transactionId: type: "string" description: "This field, when combined with the transactionType field, provide a unique identifier of the monetary\ \ transaction. A monetary transaction can be a sales order, an order refund\ \ to the buyer, a credit to the seller's account, a debit to the seller\ \ for the purchase of a shipping label, or a transaction where eBay recouped\ \ money from the seller if the seller lost a buyer-initiated payment dispute." transactionMemo: type: "string" description: "This field applies to shipping label transactions, sales transactions\ \ where payout is on hold, and non-sale charge fees. The following are\ \ examples of how the field is used for each transaction type:

Shipping\ \ label purchase: the transactionMemo field gives details about\ \ a purchase, a refund, or a price adjustment to the cost of the shipping\ \ label.
Sales transactions with funds on hold: the transactionMemo\ \ field provides information on the reason for the hold or when the hold\ \ will be released (e.g., \"Funds on hold. Estimated release on Jun 1\"\ ).
Non-sale charge fees: the transactionMemo field\ \ will provide the type of fee that was charged, such as Promoted Offsite\ \ Fee.

This field is only returned if applicable/available." transactionStatus: type: "string" description: "This enumeration value indicates the current status of the\ \ seller payout associated with the monetary transaction. See the TransactionStatusEnum\ \ type for more information on the different states. For implementation\ \ help, refer to eBay\ \ API documentation" transactionType: type: "string" description: "This enumeration value indicates the type of monetary transaction.\ \ Examples of monetary transactions include a buyer's payment for an order,\ \ a refund to the buyer for a returned item or cancelled order, or a credit\ \ issued by eBay to the seller's account. For a complete list of monetary\ \ transaction types within the Finances API, see the\ \ TransactionTypeEnum\ \ type. For implementation help, refer to eBay\ \ API documentation" description: "This type is used to express the details of one of the following\ \ monetary transactions: a buyer's payment for an order, a refund to the buyer\ \ for a returned item or cancelled order, or a credit issued by eBay to the\ \ seller's account." TransactionSummaryResponse: type: "object" properties: adjustmentAmount: description: "Total adjustment amount for given payee within a specified\ \ period." $ref: "#/components/schemas/Amount" adjustmentBookingEntry: type: "string" description: "The credit debit sign indicator for adjustment. For implementation\ \ help, refer to eBay\ \ API documentation" adjustmentCount: type: "integer" description: "Total adjustment count for given payee within a specified\ \ period." format: "int32" balanceTransferAmount: description: "The total balance transfer amount for given payee within the\ \ specified period." $ref: "#/components/schemas/Amount" balanceTransferBookingEntry: type: "string" description: "The credit debit sign indicator for the balance transfer.\ \ For implementation help, refer to eBay\ \ API documentation" balanceTransferCount: type: "integer" description: "The total balance transfer count for given payee within the\ \ specified period." format: "int32" creditAmount: description: "This amount is the total dollar value of all the seller's\ \ sales and/or credits that match the input criteria.

Note: Unless the transactionType filter\ \ is used in the request to retrieve a specific type of monetary transaction,\ \ the creditCount and creditAmount fields account for both\ \ order sales and seller credits (the count and value is not distinguished\ \ between the two monetary transaction types).

If there\ \ are no sales/credits (creditCount=0),\ \ this container is not returned." $ref: "#/components/schemas/Amount" creditBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the creditAmount field is a charge (debit) to the\ \ seller or a credit. Typically, the enumeration value returned here will\ \ be CREDIT. For implementation help, refer to eBay\ \ API documentation" creditCount: type: "integer" description: "This integer value indicates the total number of the seller's\ \ sales and/or credits that match the input criteria.

Note: Unless the transactionType filter\ \ is used in the request to retrieve a specific type of monetary transaction\ \ (sale, buyer refund, or seller credit), the creditCount and creditAmount\ \ fields account for both order sales and seller credits (the count and\ \ value is not distinguished between the two monetary transaction types).

This\ \ field is generally returned, even if 0, but it will not\ \ be returned if a transactionType filter is used, and\ \ its value is set to either REFUND, DISPUTE,\ \ or SHIPPING_LABEL." format: "int32" disputeAmount: description: "This amount is the total dollar value associated with any\ \ existing payment disputes that have been initiated by one or more buyers.\ \ Only the orders that match the input criteria are considered. The Payment\ \ Disputes methods in the Fulfillment API can be used by the seller to\ \ retrieve more information about any payment disputes.

If there\ \ are no payment disputes (disputeCount=0),\ \ this container is not returned." $ref: "#/components/schemas/Amount" disputeBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the disputeAmount field is a charge (debit) to the\ \ seller or a credit. Typically, the enumeration value returned here will\ \ be DEBIT, but its possible that CREDIT could\ \ be returned if the seller contested one or more payment disputes and\ \ won the dispute. For implementation help, refer to eBay\ \ API documentation" disputeCount: type: "integer" description: "This integer value indicates the total number of payment disputes\ \ that have been initiated by one or more buyers. Only the orders that\ \ match the input criteria are considered. The Payment Disputes methods\ \ in the Fulfillment API can be used by the seller to retrieve more information\ \ about any payment disputes.

This field is generally returned,\ \ even if 0, but it will not be returned if a transactionType\ \ filter is used, and its value is set to any value other than DISPUTE." format: "int32" loanRepaymentAmount: description: "The sum of all LOAN_REPAYMENT transactions (i.e.,\ \ debit and credit,) that match the input criteria.

For example,\ \ within a specified transactionDate range, three LOAN_REPAYMENT\ \ transactions are identified:

DEBIT of 15.00 USD
DEBIT\ \ of 10.00 USD
CREDIT of 5.00 USD

The net amount\ \ of these three transactions is a DEBIT of 20.00 USD to the seller's\ \ account. Therefore, the value returned for loanRepaymentAmount\ \ will be 20.00 USD.

Note:\ \ For this example:

The value returned for loanRepaymentCount\ \ will be 3
The loanRepaymentBookingEntry\ \ will be DEBIT

If there are no transactions\ \ that match the input criteria (i.e., loanRepaymentCount=0,)\ \ this container is not returned." $ref: "#/components/schemas/Amount" loanRepaymentBookingEntry: type: "string" description: "The enumeration value indicates whether the loanRepaymentAmount\ \ is a DEBIT against, or a CREDIT to, the sellers's\ \ account.

For most loanRepaymentAmount transactions,\ \ loanRepaymentBookingEntry will be DEBIT. However,\ \ if a loan repayment transaction is reversed, that transaction will be\ \ shown as a CREDIT. For implementation help, refer to eBay\ \ API documentation" loanRepaymentCount: type: "integer" description: "This integer value indicates the total number of LOAN_REPAYMENT\ \ transactions (i.e., DEBIT and CREDIT,) that\ \ match the input criteria.

This field is generally returned even\ \ if it equals 0. However it will not be returned if a transactionType\ \ filter is used and its value has been set to any enumeration value other\ \ than LOAN_REPAYMENT." format: "int32" nonSaleChargeAmount: description: "The total non-sale charge amount for given payee within a\ \ specified period." $ref: "#/components/schemas/Amount" nonSaleChargeBookingEntry: type: "string" description: "The credit/debit sign indicator for the non-sale charge. For\ \ implementation help, refer to eBay\ \ API documentation" nonSaleChargeCount: type: "integer" description: "The total non-sale charge count for given payee within a specified\ \ period." format: "int32" onHoldAmount: description: "This amount is the total dollar value of order sales where\ \ the associated funds are on hold. Only the orders that match the input\ \ criteria are considered.

If there are no seller payment holds\ \ (onHoldCount=0), this container is not\ \ returned." $ref: "#/components/schemas/Amount" onHoldBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the onHoldAmount field is a charge (debit) to the\ \ seller or a credit. Typically, the enumeration value returned here will\ \ be CREDIT, since on-hold funds should eventually be released\ \ as part of a payout to the seller once the hold is cleared. For implementation\ \ help, refer to eBay\ \ API documentation" onHoldCount: type: "integer" description: "This integer value indicates the total number of order sales\ \ where the associated funds are on hold. Only the orders that match the\ \ input criteria are considered.

This field is generally returned,\ \ even if 0, but it will not be returned if a transactionStatus\ \ filter is used, and its value is set to any value other than FUNDS_ON_HOLD." format: "int32" purchaseAmount: description: "Note: The PURCHASE\ \ transaction type is currently only applicable in the US marketplace.
This\ \ amount is the total dollar value of all the purchases that have been\ \ initiated by a seller using spendable funds that match the input criteria.

If\ \ there are no transactions that match the input criteria (i.e., purchaseCount=0),\ \ this container will not be returned." $ref: "#/components/schemas/Amount" purchaseBookingEntry: type: "string" description: "Note: The PURCHASE\ \ transaction type is currently only applicable in the US marketplace.
This\ \ enumeration value indicates whether the dollar amount in the purchase\ \ field is a charge (debit) to the seller or a credit. For implementation\ \ help, refer to eBay\ \ API documentation" purchaseCount: type: "integer" description: "Note: The PURCHASE\ \ transaction type is currently only applicable in the US marketplace.
This\ \ integer value indicates the total number of purchases that have been\ \ initiated by a seller using spendable funds that match the input criteria.

This\ \ field is generally returned, even if it equals 0. However,\ \ it will not be returned if a transactionType filter is\ \ used and its value has been set to any enumeration value other than\ \ PURCHASE." format: "int32" refundAmount: description: "This amount is the total dollar value of buyer refunds that\ \ match the input criteria.

If there are no refunds (refundCount=0),\ \ this container is not returned." $ref: "#/components/schemas/Amount" refundBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the refundAmount field is a charge (debit) to the\ \ seller or a credit. Typically, the enumeration value returned here will\ \ be DEBIT since this a refund from the seller to the buyer.\ \ For implementation help, refer to eBay\ \ API documentation" refundCount: type: "integer" description: "This integer value indicates the total number of buyer refunds\ \ that match the input criteria.

This field is generally returned,\ \ even if 0, but it will not be returned if a transactionType\ \ filter is used, and its value is set to any value other than REFUND." format: "int32" shippingLabelAmount: description: "This is the total dollar value of the eBay shipping labels\ \ purchased by the seller.

Note:\ \ eBay SHIPPING_LABEL transactions paid through PayPal are not currently\ \ supported by the Finances API, so those transactions will not be reflected\ \ in the amounts returned in this container." $ref: "#/components/schemas/Amount" shippingLabelBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the shippingLabelAmount field is a charge (debit)\ \ to the seller or a credit. Typically, the enumeration value returned\ \ here will be DEBIT, as eBay will charge the seller when\ \ eBay shipping labels are purchased, but it can be CREDIT\ \ if the seller was refunded for a shipping label or was possibly overcharged\ \ for a shipping label.

Note:\ \ eBay SHIPPING_LABEL transactions paid through PayPal are not currently\ \ supported by the Finances API, so those transactions will not be reflected\ \ in this field. For implementation help, refer to eBay\ \ API documentation" shippingLabelCount: type: "integer" description: "This is the total number of eBay shipping labels purchased\ \ by the seller. The count returned here may depend on the specified input\ \ criteria.

Note: eBay SHIPPING_LABEL\ \ transactions paid through PayPal are not currently supported by the\ \ Finances API, so those transactions will not be reflected in the count\ \ returned in this container." format: "int32" transferAmount: description: "This amount is the total dollar value of buyer refund transfers\ \ that match the input criteria.

If there are no transfers (refundCount=0),\ \ this container is not returned." $ref: "#/components/schemas/Amount" transferBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the transferAmount field is a charge (debit) to\ \ the seller or a credit. Typically, the enumeration value returned here\ \ will be DEBIT since this a seller reimbursement to eBay\ \ for buyer refunds. For implementation help, refer to eBay\ \ API documentation" transferCount: type: "integer" description: "This integer value indicates the total number of buyer refund\ \ transfers that match the input criteria.

This field is generally\ \ returned, even if 0, but it will not be returned if a transactionType\ \ filter is used, and its value is set to any value other than TRANSFER." format: "int32" withdrawalAmount: description: "This amount is the total dollar value of on-demand payouts\ \ (withdrawals) that match the input criteria.

If there are no\ \ withdrawals (withdrawalCount=0), this\ \ container is not returned." $ref: "#/components/schemas/Amount" withdrawalBookingEntry: type: "string" description: "The enumeration value indicates whether the dollar amount\ \ in the withdrawalAmount field is a charge (debit) to\ \ the seller or a credit. Typically, the enumeration value returned here\ \ will be DEBIT since this transaction involves a debit to\ \ the seller's available payout funds. For implementation help, refer\ \ to eBay\ \ API documentation" withdrawalCount: type: "integer" description: "This integer value indicates the total number of on-demand\ \ payouts (withdrawals) that match the input criteria.

This field\ \ is generally returned, even if 0, but it will not be returned\ \ if a transactionType filter is used, and its value\ \ is set to any value other than WITHDRAWAL." format: "int32" description: "This type is the base response type of the getTransactionSummary\ \ method, and based on the filters that are used in the getTransactionSummary\ \ call URI, the response may include total count and amount of the seller's\ \ sales and credits, total count and amount of buyer refunds, and total count\ \ and amount of seller payment holds." Transactions: type: "object" properties: href: type: "string" description: "The URI of the getTransactions method request that\ \ produced the current page of the result set." limit: type: "integer" description: "The maximum number of monetary transactions 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 monetary transactions than the limit value. \ \ To determine the number of pages in a result set, divide the total\ \ value (total number of monetary transactions 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 monetary transactions) and the limit value\ \ was 50 (show 50 monetary transactions per page), the total\ \ number of pages in the result set is three, so the seller would have\ \ to make three separate getTransactions calls to view\ \ all monetary transactions matching the input criteria.

Maximum:\ \ 200
Default: 20" format: "int32" next: type: "string" description: "The getTransactions method 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 monetary transaction returned on the current page has in the results\ \ set. So, if you wanted to view the 11th monetary transaction 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 monetary transactions 31 thru 40 from the resulting collection\ \ of monetary transactions.

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" prev: type: "string" description: "The getTransactions method 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 amount of monetary transactions\ \ in the result set based on the current input criteria. Based on the\ \ total number of monetary transactions that match the criteria, and on\ \ the limit and offset values, there\ \ may be additional pages in the results set." format: "int32" transactions: type: "array" description: "An array of one or more monetary transactions that match the\ \ input criteria. Details for each monetary transaction may include the\ \ unique identifier of the order associated with the monetary transaction,\ \ the status of the transaction, the amount of the order, the order's\ \ buyer, and the unique identifier of the payout (if a payout has been\ \ initiated/issued for the order)." items: $ref: "#/components/schemas/Transaction" description: "This is the base response type of the getTransactions method.\ \ The getTransactions response includes details on one or more monetary\ \ transactions that match the input criteria, as well as pagination data. " Transfer: type: "object" properties: fundingSource: description: "This container provides details about the seller's funding\ \ source to reimburse eBay for the transfer, such as a bank account, a\ \ credit card, or available seller payout funds." $ref: "#/components/schemas/FundingSource" transactionDate: type: "string" description: "This timestamp indicates the date/time of the transfer. The\ \ following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ.\ \ For example, 2020-08-04T19:09:02.768Z" transferAmount: description: "The amount of the transfer being deducted from the funding\ \ source." $ref: "#/components/schemas/Amount" transferDetail: description: "This container provides more details about the transfer, including\ \ details on the charge(s) associated with the transfer. Multiple charges\ \ can be addressed with one transfer." $ref: "#/components/schemas/TransferDetail" transferId: type: "string" description: "The unique identifier of the TRANSFER transaction\ \ type. This is the same value that was passed into the end of the call\ \ URI." description: "This type is the base response type used by TRANSFER\ \ transaction type that is returned in the response." TransferDetail: type: "object" properties: balanceAdjustment: description: "This container shows the seller payout balance that will be\ \ applied toward the charges outlined in the charges array." $ref: "#/components/schemas/BalanceAdjustment" charges: type: "array" description: "This container is an array of one or more charges related\ \ to the transfer. Charges can be related to an order cancellation, order\ \ return, case, payment dispute, etc." items: $ref: "#/components/schemas/Charge" totalChargeNetAmount: description: "This container shows the total amount that the seller owes\ \ for all of the charges outlined in the charges array." $ref: "#/components/schemas/Amount" description: "This type is used by the transferDetail container, which\ \ provides more details about the transfer and the charge(s) associated with\ \ the transfer." 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.finances: "View and manage your\ \ payment and order information to display this information to you and\ \ allow you to initiate refunds using the third party application"