--- name: finances-api description: "Finances API skill. Use when working with Finances for order_earnings, order_earnings_summary, payout. Covers 11 endpoints." version: 1.0.0 generator: lapsh --- # Finances API API version: v1.19.0 ## Auth OAuth2 ## Base URL https://apiz.ebay.com/sell/finances/v1 ## Setup 1. Configure auth: OAuth2 2. 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. 3. Explore available endpoints below ## Endpoints 11 endpoints across 9 groups. See references/api-spec.lap for full details. ### Order_earnings | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | ### Order_earnings_summary | Method | Path | Description | |--------|------|-------------| | 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. | ### Payout | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | ### Payout_summary | Method | Path | Description | |--------|------|-------------| | 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. | ### Seller_funds_summary | Method | Path | Description | |--------|------|-------------| | 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. | ### Transaction | Method | Path | Description | |--------|------|-------------| | 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. | ### Transaction_summary | Method | Path | Description | |--------|------|-------------| | 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. | ### Transfer | Method | Path | Description | |--------|------|-------------| | 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. | ### Billing_activity | Method | Path | Description | |--------|------|-------------| | 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. | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "List all order_earnings?" -> GET /order_earnings - "Get order_earning details?" -> GET /order_earnings/{order_id} - "List all order_earnings_summary?" -> GET /order_earnings_summary - "Get payout details?" -> GET /payout/{payout_Id} - "List all payout?" -> GET /payout - "List all payout_summary?" -> GET /payout_summary - "List all seller_funds_summary?" -> GET /seller_funds_summary - "List all transaction?" -> GET /transaction - "List all transaction_summary?" -> GET /transaction_summary - "Get transfer details?" -> GET /transfer/{transfer_Id} - "List all billing_activity?" -> GET /billing_activity - "How to authenticate?" -> See Auth section above ## Response Tips - Check response schemas in references/api-spec.lap for field details - Paginated endpoints accept limit/offset or cursor parameters - Error responses include status codes and descriptions in the spec ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)