{"files":{"SKILL.md":"---\nname: finances-api\ndescription: \"Finances API skill. Use when working with Finances for order_earnings, order_earnings_summary, payout. Covers 11 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Finances API\nAPI version: v1.19.0\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://apiz.ebay.com/sell/finances/v1\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /order_earnings -- this method returns detailed order-level financial data for each order associated with a seller account. the returned order-level financial data includes order earnings, gross amount, expenses, and refunds. order earnings includes earnings after deducting expenses and refunds from the gross amount. note: expenses include fees, shipping labels, and donations. refunds include gross refunds, gross claims, and gross payment disputes.the financial data for orders will be returned as filtered based on the order's creation date. note: only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.pagination is supported through the limit and offset parameters. these parameters can be used to control the number of records returned in a single response and to retrieve subsequent pages of results when the result set spans multiple pages.the response can be filtered by using the filter parameter. this parameter allows consumers to restrict the results returned by the method based on supported filtering criteria.note: access to the order_earnings resource is currently limited to only us, china, or hong kong sellers who meet the following criteria and also request access: - us sellers with the country of residence set to us and having a payout currency in usd.- hong kong or china sellers having the country of residence set to hk or cn and the payout currency set to usd have access.to request access, submit an application growth check to have the required oauth scope added to your app. after submission, you can use the same growth check link to track the status of the request. ebay plans on expanding this to other markets in the future.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 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.\n3. Explore available endpoints below\n\n## Endpoints\n11 endpoints across 9 groups. See references/api-spec.lap for full details.\n\n### Order_earnings\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /order_earnings | This method returns detailed order-level financial data for each order associated with a seller account. The returned order-level financial data includes order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount. Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.The financial data for orders will be returned as filtered based on the order's creation date. Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.Pagination is supported through the limit and offset parameters. These parameters can be used to control the number of records returned in a single response and to retrieve subsequent pages of results when the result set spans multiple pages.The response can be filtered by using the filter parameter. This parameter allows consumers to restrict the results returned by the method based on supported filtering criteria.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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. |\n| GET | /order_earnings/{order_id} | This method returns detailed order-level financial data including order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount.Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.The response returns earnings information only for the order identified by the order_id path parameter.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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. |\n\n### Order_earnings_summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /order_earnings_summary | This method returns a summarized view of order earnings information for one or more orders associated with a seller account. The method retrieves aggregated data for order earnings after deducting expenses and refunds from the gross amount. You can use this method for high-level financial reporting workflows.Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.The response can be filtered by using the filter parameter. This parameter allows consumers to restrict the summary results returned by the method based on supported filtering criteria.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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. |\n\n### Payout\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /payout/{payout_Id} | 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 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. |\n| GET | /payout | 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 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 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. |\n\n### Payout_summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /payout_summary | 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 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 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. Note: getPayoutSummary will only return data on payouts that occurred less than five years in the past. |\n\n### Seller_funds_summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /seller_funds_summary | 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 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 all pending funds that have not yet been distributed 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 204 - No Content is returned instead. |\n\n### Transaction\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /transaction | 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 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.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 TransactionTypeEnum.Numerous input filters are available which can be used individually or combined to refine the data that are returned. For example: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. |\n\n### Transaction_summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /transaction_summary | 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 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.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. |\n\n### Transfer\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /transfer/{transfer_Id} | 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 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 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. |\n\n### Billing_activity\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /billing_activity | 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 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 filtered billing activities of the seller. Returned results are filtered through query parameters such as date range, activity ID, listing ID, or order ID. Sorting and pagination features help organize and navigate returned activities efficiently. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all order_earnings?\" -> GET /order_earnings\n- \"Get order_earning details?\" -> GET /order_earnings/{order_id}\n- \"List all order_earnings_summary?\" -> GET /order_earnings_summary\n- \"Get payout details?\" -> GET /payout/{payout_Id}\n- \"List all payout?\" -> GET /payout\n- \"List all payout_summary?\" -> GET /payout_summary\n- \"List all seller_funds_summary?\" -> GET /seller_funds_summary\n- \"List all transaction?\" -> GET /transaction\n- \"List all transaction_summary?\" -> GET /transaction_summary\n- \"Get transfer details?\" -> GET /transfer/{transfer_Id}\n- \"List all billing_activity?\" -> GET /billing_activity\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Finances API\n@base https://apiz.ebay.com/sell/finances/v1\n@version v1.19.0\n@auth OAuth2\n@endpoints 11\n@toc order_earnings(2), order_earnings_summary(1), payout(2), payout_summary(1), seller_funds_summary(1), transaction(1), transaction_summary(1), transfer(1), billing_activity(1)\n\n@group order_earnings\n@endpoint GET /order_earnings\n@desc This method returns detailed order-level financial data for each order associated with a seller account. The returned order-level financial data includes order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount. Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.The financial data for orders will be returned as filtered based on the order's creation date. Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.Pagination is supported through the limit and offset parameters. These parameters can be used to control the number of records returned in a single response and to retrieve subsequent pages of results when the result set spans multiple pages.The response can be filtered by using the filter parameter. This parameter allows consumers to restrict the results returned by the method based on supported filtering criteria.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # This parameter can be used to filter orders created within a specified date range. The filter uses the orderCreationDate field, which works similarly to the transactionDate filter used by the Transactions API. Currently, orderCreationDate is the only supported filter value. 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.Default: If no value is specified, results from the past year will be returned. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField, limit: str # This parameter configures the number of orders 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 orders 11 thru 20 from the result set.  Note: This feature employs a zero-based list, where the first page in the results set has an offset value of 0.   Maximum: 200  Default: 20, offset: str # This parameter can be used to specify the number of records to skip before returning results. This parameter is commonly used with the limit parameter to retrieve the next page of results.Maximum: 10,000Default: 0, sort: str # This parameter can be used to specify the sort order of the results. Currently, sorting is supported by order creation date. Default: Results returned in ascending order sorted by orderCreationDate, with earliest creation date first. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:SortField}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), orders: [map], prev: str, total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /order_earnings/{order_id}\n@desc This method returns detailed order-level financial data including order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount.Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.The response returns earnings information only for the order identified by the order_id path parameter.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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., order_id: str # This path parameter identifies the specific order for which earnings information is requested.}\n@returns(200) {buyer: map{userId: str, username: str}, orderCreationDate: str, orderEarningsSummary: map{expenses: map{currency: str, donations: [map], marketplaceFees: [map], shippingLabels: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, value: str}, grossAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, orderEarnings: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, refunds: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}}, orderId: str, orderLastModifiedDate: str, orderSummary: map{discounts: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, itemSubtotal: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, sellerCollectedTaxes: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, shippingAndHandlingCosts: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}}} # Success\n@errors {400: Bad Request, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group order_earnings_summary\n@endpoint GET /order_earnings_summary\n@desc This method returns a summarized view of order earnings information for one or more orders associated with a seller account. The method retrieves aggregated data for order earnings after deducting expenses and refunds from the gross amount. You can use this method for high-level financial reporting workflows.Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.Note: Only charges and credits tied to the order are shown, and they appear in near real time for orders created within the selected order creation time window.The response can be filtered by using the filter parameter. This parameter allows consumers to restrict the summary results returned by the method based on supported filtering criteria.Note: Access to the order_earnings resource is currently limited to only US, China, or Hong Kong sellers who meet the following criteria and also request access: - US sellers with the country of residence set to US and having a payout currency in USD.- Hong Kong or China sellers having the country of residence set to HK or CN and the payout currency set to USD have access.To request access, submit an application growth check to have the required OAuth scope added to your app. After submission, you can use the same growth check link to track the status of the request. eBay plans on expanding this to other markets in the future.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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # This parameter can be used to filter orders created within a specified date range. The filter uses the orderCreationDate field, which works similarly to the transactionDate filter used by the Transactions API. Currently, orderCreationDate is the only supported filter value.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.Default: If no value is specified, results from the past year will be returned. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField}\n@returns(200) {expenses: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, grossAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, orderCount: map, orderEarnings: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, refunds: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group payout\n@endpoint GET /payout/{payout_Id}\n@desc 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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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., payout_Id: str # 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.}\n@returns(200) {amount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, bankReference: str, lastAttemptedPayoutDate: str, payoutDate: str, payoutId: str, payoutInstrument: map{accountLastFourDigits: str, instrumentType: str, nickname: str, payoutPercentage: str}, payoutMemo: str, payoutReference: str, payoutStatus: str, payoutStatusDescription: str, totalAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, totalFee: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, totalFeeDetails: [map], transactionCount: int(int32)} # Success\n@errors {400: Bad Request, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /payout\n@desc 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 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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # 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, limit: str # 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, offset: str # 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), sort: str # 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=payoutDatePayouts 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}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), payouts: [map], prev: str, total: int(int32)} # Success\n@returns(204) No Content\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group payout_summary\n@endpoint GET /payout_summary\n@desc 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 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 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. Note: getPayoutSummary will only return data on payouts that occurred less than five years in the past.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect all payouts in all states that have occurred within the last five years: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}\n@returns(200) {amount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, payoutCount: int(int32), transactionCount: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group seller_funds_summary\n@endpoint GET /seller_funds_summary\n@desc 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 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 all pending funds that have not yet been distributed 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 204 - No Content is returned instead.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@returns(200) {availableFunds: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, fundsOnHold: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, processingFunds: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, totalFunds: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}} # Success\n@returns(204) No Content\n@errors {500: Internal Server Error}\n\n@endgroup\n\n@group transaction\n@endpoint GET /transaction\n@desc 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 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.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 TransactionTypeEnum.Numerous input filters are available which can be used individually or combined to refine the data that are returned. For example: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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # 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, limit: str # 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, offset: str # 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), sort: str # 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=transactionDateTransactions 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}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32), transactions: [map]} # Success\n@returns(204) No Content\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group transaction_summary\n@endpoint GET /transaction_summary\n@desc 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 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.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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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.}\n@optional {filter: str # 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}\n@returns(200) {adjustmentAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, adjustmentBookingEntry: str, adjustmentCount: int(int32), balanceTransferAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, balanceTransferBookingEntry: str, balanceTransferCount: int(int32), creditAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, creditBookingEntry: str, creditCount: int(int32), disputeAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, disputeBookingEntry: str, disputeCount: int(int32), loanRepaymentAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, loanRepaymentBookingEntry: str, loanRepaymentCount: int(int32), nonSaleChargeAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, nonSaleChargeBookingEntry: str, nonSaleChargeCount: int(int32), onHoldAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, onHoldBookingEntry: str, onHoldCount: int(int32), purchaseAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, purchaseBookingEntry: str, purchaseCount: int(int32), refundAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, refundBookingEntry: str, refundCount: int(int32), shippingLabelAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, shippingLabelBookingEntry: str, shippingLabelCount: int(int32), transferAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, transferBookingEntry: str, transferCount: int(int32), withdrawalAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, withdrawalBookingEntry: str, withdrawalCount: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group transfer\n@endpoint GET /transfer/{transfer_Id}\n@desc 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 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 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # 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., transfer_Id: str # 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.}\n@returns(200) {fundingSource: map{brand: str, memo: str, type: str}, transactionDate: str, transferAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, transferDetail: map{balanceAdjustment: map{adjustmentAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}, adjustmentType: str}, charges: [map], totalChargeNetAmount: map{convertedFromCurrency: str, convertedFromValue: str, convertedToCurrency: str, convertedToValue: str, currency: str, exchangeRate: str, value: str}}, transferId: str} # Success.\n@errors {400: Bad Request, 404: Not found., 500: Internal Server Error}\n\n@endgroup\n\n@group billing_activity\n@endpoint GET /billing_activity\n@desc 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 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 filtered billing activities of the seller. Returned results are filtered through query parameters such as date range, activity ID, listing ID, or order ID. Sorting and pagination features help organize and navigate returned activities efficiently.\n@optional {Accept-Language: str # This header indicates the natural language and locale preferred by the user for the response.For more information, see the Accept-Language header in HTTP request headers and Marketplace ID values. If not provided, defaults to en-US., filter: str # This required field specifies which results to return in the response. Only one of the following four filter values must be used. A user can either retrieve all billing activity within a date range, or they can retrieve billing activity related to a specific eBay order, eBay listing, or they can retrieve information on a specific billing activity.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]ExamplesIDs: 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, limit: str # 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: 1Maximum: 200Default: 100, offset: str # 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 returnedIf 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), sort: str # 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=transactionDateTransactions 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}\n@returns(200) {billingActivities: [map], count: int(int32), limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # OK\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}