openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 99.2 kB

JSON

{"openapi":"3.0.0","servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/finances/v1"}}}],"info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"This API is used to retrieve seller payouts and monetary transaction details related to those payouts.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"eBay Finances API","version":"v1.15.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/sell/finances/openapi/3/sell_finances_v1_oas3.json","version":"3.0"}],"x-providerName":"apiz.ebay.com","x-serviceName":"sell-finances"},"paths":{"/payout":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> 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.","operationId":"getPayouts","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"description":"The three filter types that can be used here are discussed below. If none of these filters are used, all recent payouts in all states are returned:<ul><li>payoutDate: search for payouts within a specific range of dates. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. Below is the proper syntax to use if filtering by a date range: <code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]</code> Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.</li><li>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 <code>RETRYABLE_FAILED</code>. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. The same syntax used for the payoutDate filter is also used for the lastAttemptedPayoutDate filter. This filter is only applicable (and will return results) if one or more seller payouts have failed, but are retryable.</li> <li>payoutStatus: search for payouts in a particular state. Only one payout state can be specified with this filter. The supported payoutStatus values are as follows:<ul><li><code>INITIATED</code>: search for payouts that have been initiated but not processed.</li><li><code>SUCCEEDED</code>: search for successful payouts.</li><li><code>RETRYABLE_FAILED</code>: search for payouts that failed, but ones which will be tried again. This value must be used if filtering by lastAttemptedPayoutDate. </li><li><code>TERMINAL_FAILED</code>: search for payouts that failed, and ones that will not be tried again.</li><li> <code>REVERSED</code>: search for payouts that were reversed. </li></ul>Below is the proper syntax to use if filtering by payout status: <code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutStatus:{SUCCEEDED}</code></ul> 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","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"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 <code>10</code> and limit is set to <code>10</code>, 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 <code>0</code>. Maximum: <code>200</code> Default: <code>20</code>","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"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 <code>10</code>. 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 <code>30</code> and limit is set to <code>10</code>, the method retrieves payouts 31 thru 40 from the resulting collection of payouts. Note: This feature employs a zero-based list, where the first payout in the results set has an offset value of <code>0</code>. Default: <code>0</code> (zero)","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"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 <code>payoutDate</code> or <code>lastAttemptedPayoutDate</code> (if searching for failed, retryable payouts). Below is the proper syntax to use if filtering by a payout date range in ascending order: <code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]&sort=payoutDate</code> 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","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts"}}},"description":"Success"},"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"135002":{"category":"REQUEST","description":"The value of payout status filter is invalid.","domain":"API_FINANCES"},"135003":{"category":"REQUEST","description":"The value of pagination is invalid.","domain":"API_FINANCES"},"135004":{"category":"REQUEST","description":"The value of payout date filter is invalid.","domain":"API_FINANCES"},"135005":{"category":"REQUEST","description":"The value of sorting is invalid.","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["payout"]}},"/payout/{payout_Id}":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> This method retrieves details on a specific seller payout. The unique identfier of the payout is passed in as a path parameter at the end of the call URI. The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub.","operationId":"getPayout","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"description":"The unique identfier of the payout is passed in as a path parameter at the end of the call URI. The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub to get the payout ID.","in":"path","name":"payout_Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payout"}}},"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Not found","x-response-codes":{"errors":{"135001":{"category":"REQUEST","description":"The payout id was not found.","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["payout"]}},"/payout_summary":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> This method is used to retrieve cumulative values for payouts in a particular state, or all states. The metadata in the response includes total payouts, the total number of monetary transactions (sales, refunds, credits) associated with those payouts, and the total dollar value of all payouts. If the filter query parameter is used to filter by payout status, only one payout status value may be used. If the filter query parameter is not used to filter by a specific payout status, cumulative values for payouts in all states are returned. The user can also use the filter query parameter to specify a date range, and then only payouts that were processed within that date range are considered.","operationId":"getPayoutSummary","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"description":"The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect payouts, in all states, processed within the last 90 days. <ul><li>payoutDate: consider payouts processed within a specific range of dates. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. Below is the proper syntax to use if filtering by a date range: <code>https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]</code> Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.</li> <li>payoutStatus: consider only the payouts in a particular state. Only one payout state can be specified with this filter. The supported payoutStatus values are as follows:<ul><li><code>INITIATED</code>: search for payouts that have been initiated but not processed.</li><li><code>SUCCEEDED</code>: consider only successful payouts.</li><li><code>RETRYABLE_FAILED</code>: consider only payouts that failed, but ones which will be tried again.</li><li><code>TERMINAL_FAILED</code>: consider only payouts that failed, and ones that will not be tried again.</li><li> <code>REVERSED</code>: consider only payouts that were reversed. </li></ul>Below is the proper syntax to use if filtering by payout status: <code>https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutStatus:{SUCCEEDED}</code></ul> 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","in":"query","name":"filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutSummaryResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"135002":{"category":"REQUEST","description":"The value of payout status filter is invalid","domain":"API_FINANCES"},"135004":{"category":"REQUEST","description":"The value of payout date filter is invalid","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["payout"]}},"/seller_funds_summary":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> This method retrieves all pending funds that have not yet been distibuted through a seller payout. There are no input parameters for this method. The response payload includes available funds, funds being processed, funds on hold, and also an aggregate count of all three of these categories. 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 <code>204 - No Content</code> is returned instead.","operationId":"getSellerFundsSummary","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerFundsSummaryResponse"}}},"description":"Success"},"204":{"description":"No Content"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["seller_funds_summary"]}},"/transaction":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> The getTransactions method allows a seller to retrieve information about one or more of their monetary transactions. Note: For a complete list of transaction types, refer to <a href=\"/api-docs/sell/finances/types/pay:TransactionTypeEnum \" target=\"_blank \">TransactionTypeEnum</a>. Numerous input filters are available which can be used individualy or combined to refine the data that are returned. For example:<ul><li><code>SALE</code> transactions for August 15, 2022;</li><li><code>RETURN</code> transactions for the month of January, 2021;</li><li>Transactions currently in a <code>transactionStatus</code> equal to <code>FUNDS_ON_HOLD</code>.</li></ul>Refer to the <a href=\"#uri.filter \">filter</a> 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.","operationId":"getTransactions","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"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 from the last 90 days are returned:<ul><li>transactionDate: search for monetary transactions that occurred within a specific range of dates. Note: All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) 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: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]</code> Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.</li> <li>transactionType: search for a specific type of monetary transaction. The supported transactionType values are as follows:<ul><li><code>SALE</code>: a sales order.</li><li> <code>REFUND</code>: a refund to the buyer after an order cancellation or return.</li><li><code>CREDIT</code>: a credit issued by eBay to the seller's account.</li><li><code>DISPUTE</code>: a monetary transaction associated with a payment dispute between buyer and seller.</li><li><code>NON_SALE_CHARGE</code>: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.</li><li><code>SHIPPING_LABEL</code>: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.</li><li><code>TRANSFER</code>: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.</li><li><code>ADJUSTMENT</code>: An adjustment is a monetary transaction where eBay is crediting or debiting the seller's account.</li><li><code>WITHDRAWAL</code>: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay. Note: On-demand payout is not available for sellers who are already on a daily payout schedule. In order to initiate an on-demand payout, a seller must be on a weekly, bi-weekly, or monthly payout schedule.</li><li><code>LOAN_REPAYMENT</code>: A monetary transaction related to the repayment of an outstanding loan balance for approved participants enrolled in the <a href=\"https://pages.ebay.com/sellercapital/ \" target=\"_blank \">eBay Seller Capital financing program</a>. Note: eBay Seller Capital financing is only available in select marketplaces. Refer to <a href=\"/api-docs/sell/finances/overview.html#loans \" target=\"_blank \">Marketplace availability for eBay Seller Capital funding program</a> for current marketplace eligibility.</li></ul>Below is the proper syntax to use if filtering by a monetary transaction type: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}</code></li><li>transactionStatus: this filter type is only applicable for sales orders, and allows the user to filter seller payouts in a particular state. The supported transactionStatus values are as follows:<ul><li><code>PAYOUT</code>: this indicates that the proceeds from the corresponding sales order has been paid out to the seller's account.</li><li><code>FUNDS_PROCESSING</code>: this indicates that the funds for the corresponding monetary transaction are currently being processed.</li><li><code>FUNDS_AVAILABLE_FOR_PAYOUT</code>: this indicates that the proceeds from the corresponding sales order are available for a seller payout, but processing has not yet begun.</li><li><code>FUNDS_ON_HOLD</code>: this indicates that the proceeds from the corresponding sales order are currently being held by eBay, and are not yet available for a seller payout.</li><li><code>COMPLETED</code>: this indicates that the funds for the corresponding <code>TRANSFER</code> monetary transaction have transferred and the transaction has completed.</li><li><code>FAILED</code>: this indicates the process has failed for the corresponding <code>TRANSFER</code> monetary transaction. </li></ul>Below is the proper syntax to use if filtering by transaction status: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}</code></li><li>buyerUsername: the eBay 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: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}</code> </li><li>salesRecordReference: the unique Selling Manager identifier of the order involved in the monetary transaction. Only monetary transactions involving this Selling Manager Sales Record ID are returned. Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=salesRecordReference:{123}</code> Note: For all orders originating after February 1, 2020, a value of <code>0</code> will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date. </li><li>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: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8}</code> </li><li>transactionId: the unique identifier of a monetary transaction. 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: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}</code> </li><li>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: <code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3}</code> </li></ul> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"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 <code>10</code> and limit is set to <code>10</code>, 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 <code>0</code>. Maximum:<code> 1000</code> Default:<code> 20</code>","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"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 <code>10</code>. 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 <code>30</code> and limit is set to <code>10</code>, the method retrieves transactions 31 thru 40 from the resulting collection of transactions. Note: This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>. Default: <code>0</code> (zero)","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Sorting is not yet available for the getTransactions method. By default, monetary transactions that match the input criteria are sorted in descending order according to the transaction date. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:SortField","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transactions"}}},"description":"Success"},"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"135003":{"category":"REQUEST","description":"The value of pagination is invalid.","domain":"API_FINANCES"},"135005":{"category":"REQUEST","description":"The value of sorting is invalid.","domain":"API_FINANCES"},"135006":{"category":"REQUEST","description":"The value of transaction type filter is invalid.","domain":"API_FINANCES"},"135007":{"category":"REQUEST","description":"The value of transaction status filter is invalid.","domain":"API_FINANCES"},"135008":{"category":"REQUEST","description":"The value of transaction date filter is invalid.","domain":"API_FINANCES"},"135009":{"category":"REQUEST","description":"Transaction type filter is missing.","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["transaction"]}},"/transaction_summary":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> The getTransactionSummary method retrieves cumulative information for monetary transactions. If applicable, the number of payments with a <code>transactionStatus</code> equal to <code>FUNDS_ON_HOLD</code> and the total monetary amount of these on-hold payments are also returned. Note: For a complete list of transaction types, refer to <a href=\"/api-docs/sell/finances/types/pay:TransactionTypeEnum \" target=\"_blank \">TransactionTypeEnum</a>. Refer to the <a href=\"#uri.filter \">filter</a> field for additional information about each filter and its use. Note: Unless a <code>transactionType</code> filter is used to retrieve a specific type of transaction (e.g., <code>SALE</code>, <code>REFUND</code>, etc.,) the <a href=\"#response.creditCount\">creditCount</a> and <a href=\"#response.creditAmount\">creditAmount</a> 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.","operationId":"getTransactionSummary","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"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. <ul><li>transactionStatus: the data returned in the response pertains to the sales, payouts, and transfer status set. The supported transactionStatus values are as follows:<ul><li><code>PAYOUT</code>: only consider monetary transactions where the proceeds from the sales order(s) have been paid out to the seller's bank account.</li><li><code>FUNDS_PROCESSING</code>: only consider monetary transactions where the proceeds from the sales order(s) are currently being processed.</li><li><code>FUNDS_AVAILABLE_FOR_PAYOUT</code>: only consider monetary transactions where the proceeds from the sales order(s) are available for a seller payout, but processing has not yet begun.</li><li><code>FUNDS_ON_HOLD</code>: only consider monetary transactions where the proceeds from the sales order(s) are currently being held by eBay, and are not yet available for a seller payout.</li><li><code>COMPLETED</code>: this indicates that the funds for the corresponding <code>TRANSFER</code> monetary transaction have transferred and the transaction has completed.</li><li><code>FAILED</code>: this indicates the process has failed for the corresponding <code>TRANSFER</code> monetary transaction. </li></ul>Below is the proper syntax to use when setting up the transactionStatus filter: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}</code></li><li>transactionDate: only consider monetary transactions that occurred within a specific range of dates. Note: All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) 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: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]</code> Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.</li> <li>transactionType: only consider a specific type of monetary transaction. The supported transactionType values are as follows:<ul><li><code>SALE</code>: a sales order.</li><li> <code>REFUND</code>: a refund to the buyer after an order cancellation or return.</li><li><code>CREDIT</code>: a credit issued by eBay to the seller's account.</li><li><code>DISPUTE</code>: a monetary transaction associated with a payment dispute between buyer and seller.</li><li><code>NON_SALE_CHARGE</code>: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.</li><li><code>SHIPPING_LABEL</code>: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.</li><li><code>TRANSFER</code>: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.</li><li><code>ADJUSTMENT</code>: An adjustment is a monetary transaction where eBay is crediting or debiting the seller's account.</li><li><code>WITHDRAWAL</code>: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay. Note: On-demand payout is not available for sellers who are already on a daily payout schedule. In order to initiate an on-demand payout, a seller must be on a weekly, bi-weekly, or monthly payout schedule.</li><li><code>LOAN_REPAYMENT</code>: A monetary transaction related to the repayment of an outstanding loan balance for approved participants enrolled in the <a href=\"https://pages.ebay.com/sellercapital/ \" target=\"_blank \">eBay Seller Capital financing program</a>. Note: eBay Seller Capital financing is only available in select marketplaces. Refer to <a href=\"/api-docs/sell/finances/overview.html#loans \" target=\"_blank \">Marketplace availability for eBay Seller Capital funding program</a> for current marketplace eligibility.</li></ul>Below is the proper syntax to use if filtering by a monetary transaction type: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}</code></li><li>buyerUsername: only consider monetary transactions involving a specific buyer (specified with the buyer's eBay user ID). Below is the proper syntax to use if filtering by a specific eBay buyer: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}</code> </li><li>salesRecordReference: only consider monetary transactions corresponding to a specific order (identified with a Selling Manager order identifier). Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=salesRecordReference:{123}</code> Note: For all orders originating after February 1, 2020, a value of <code>0</code> will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date. </li><li>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: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8}</code> </li><li>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: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}</code> </li><li>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: <code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-0***0-3***3}</code> </li></ul> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField","in":"query","name":"filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionSummaryResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"135006":{"category":"REQUEST","description":"The value of transaction type filter is invalid.","domain":"API_FINANCES"},"135007":{"category":"REQUEST","description":"The value of transaction status filter is invalid.","domain":"API_FINANCES"},"135008":{"category":"REQUEST","description":"The value of transaction date filter is invalid.","domain":"API_FINANCES"},"135009":{"category":"REQUEST","description":"Transaction type filter is missing.","domain":"API_FINANCES"},"135011":{"category":"REQUEST","description":"Transaction status filter is mandatory.","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["transaction"]}},"/transfer/{transfer_Id}":{"get":{"description":"<div class=\"msgbox_important\">Important! \">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 <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</div> This method retrieves detailed information regarding a <code>TRANSFER</code> transaction type. A <code>TRANSFER</code> 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 <code>404 Not found</code>.","operationId":"getTransfer","parameters":[{"description":"This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See <a href=\"/api-docs/static/rest-request-components.html#marketpl \" target=\"_blank \">HTTP request headers</a> for the marketplace ID values.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":false,"schema":{"type":"string"}},{"description":"The unique identifier of the <code>TRANSFER</code> transaction type you wish to retrieve.","in":"path","name":"transfer_Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"Success."},"400":{"description":"Bad Request"},"404":{"description":"Not found.","x-response-codes":{"errors":{"135012":{"category":"REQUEST","description":"The transfer id was not found.","domain":"API_FINANCES"}}}},"500":{"description":"Internal Server Error.","x-response-codes":{"errors":{"135000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FINANCES"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"tags":["transfer"]}}},"components":{"schemas":{"Amount":{"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.","properties":{"convertedFromCurrency":{"description":"The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html \" target=\"_blank\">ISO 4217</a> 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 <a href='https://developer.ebay.com/api-docs/sell/finances/types/ba:CurrencyCodeEnum'>eBay API documentation</a>","type":"string"},"convertedFromValue":{"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.","type":"string"},"currency":{"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 <a href='https://developer.ebay.com/api-docs/sell/finances/types/ba:CurrencyCodeEnum'>eBay API documentation</a>","type":"string"},"exchangeRate":{"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. 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.","type":"string"},"value":{"description":"The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.","type":"string"}},"type":"object"},"BalanceAdjustment":{"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.","properties":{"adjustmentAmount":{"$ref":"#/components/schemas/Amount","description":"The seller payout balance amount that will be applied toward the charges outlined in the charges array."},"adjustmentType":{"description":"The enumeration value returned here indicates if the charge is a <code>DEBIT</code> or a <code>CREDIT</code> to the seller. Generally, all transfer transaction types are going to be <code>DEBIT</code>, since the money is being tranferred from the seller to eBay. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a>","type":"string"}},"type":"object"},"Buyer":{"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.","properties":{"username":{"description":"The eBay user ID of the order's buyer.","type":"string"}},"type":"object"},"Charge":{"description":"This type is used by the charge container, which is an array of one or more charges related to the transfer.","properties":{"cancellationId":{"description":"The unique identifier of an order cancellation. This field is only applicable and returned if the charge is related to an order cancellation.","type":"string"},"caseId":{"descript