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 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 thelimit 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.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! 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.
", "operationId": "getOrderEarnings", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "limit",
"in": "query",
"description": "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. 10 and limit is set to 10, the method retrieves orders 11 thru 20 from the result set. 0. 200 20",
"required": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "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.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.
", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sort", "in": "query", "description": "Sort order for a collection of resources. Available value: orderCreationDate For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/sqa:SortField", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEarnings" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "135005": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The value of sort is invalid." }, "135017": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The value of offset is invalid." }, "135018": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The value of limit is invalid." }, "135019": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The orderCreationDate filter is invalid due to syntax issue, or the start and end dates are not compatible with one another. Please see documentation." }, "135020": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The supplied date range is invalid, as orders before year 2024 cannot be retrieved. Please update the date range and resubmit the request." }, "135021": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The supplied date range is invalid, as the date range cannot exceed 12 months. Please update the date range and resubmit the request." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1001": { "domain": "API_FINANCES", "category": "REQUEST", "description": "Invalid access token. Check the value of the Authorization HTTP request header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1100": { "domain": "API_FINANCES", "category": "REQUEST", "description": "Insufficient permissions to fulfill the request." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "135000": { "domain": "API_FINANCES", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read" ], "oauth2_api_scope_sell_finances_earnings": [ "https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read", "eBayUser" ] } ] } }, "/order_earnings/{order_id}": { "get": { "tags": [ "order_earnings" ], "description": "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 theorder_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! 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.
", "operationId": "getOrderEarningsById", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "order_id",
"in": "path",
"description": "This path parameter identifies the specific order for which earnings information is requested.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderEarning"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"135023": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Invalid order ID format."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1100": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Insufficient permissions to fulfill the request."
}
}
}
},
"404": {
"description": "Not found",
"x-response-codes": {
"errors": {
"135022": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "The order was not found."
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"135000": {
"domain": "API_FINANCES",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read"
],
"oauth2_api_scope_sell_finances_earnings": [
"https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read",
"eBayUser"
]
}
]
}
},
"/order_earnings_summary": {
"get": {
"tags": [
"order_earnings"
],
"description": "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 thefilter 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! 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.
", "operationId": "getOrderEarningsSummary", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "filter",
"in": "query",
"description": "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.
", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEarningsSummary" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "135019": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The orderCreationDate filter is invalid due to syntax issue, or the start and end dates are not compatible with one another. Please see documentation." }, "135020": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The supplied date range is invalid, as orders before year 2024 cannot be retrieved. Please update the date range and resubmit the request." }, "135021": { "domain": "API_FINANCES", "category": "REQUEST", "description": "The supplied date range is invalid, as the date range cannot exceed 12 months. Please update the date range and resubmit the request." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1001": { "domain": "API_FINANCES", "category": "REQUEST", "description": "Invalid access token. Check the value of the Authorization HTTP request header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "1100": { "domain": "API_FINANCES", "category": "REQUEST", "description": "Insufficient permissions to fulfill the request." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "135000": { "domain": "API_FINANCES", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read" ], "oauth2_api_scope_sell_finances_earnings": [ "https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read", "eBayUser" ] } ] } }, "/payout/{payout_Id}": { "get": { "tags": [ "payout" ], "description": "Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
EBAY_US is used.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "payout_Id",
"in": "path",
"description": "This path parameter is used to specify the unique identifier of the payout being retrieved. 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.
EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "limit",
"in": "query",
"description": "The number of payouts to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. 10 and limit is set to 10, the method retrieves payouts 11 thru 20 from the result set. 0. 200 20",
"required": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10. 30 and limit is set to 10, the method retrieves payouts 31 thru 40 from the resulting collection of payouts.5000.0.0 (zero)",
"required": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": true
},
{
"name": "filter",
"in": "query",
"description": "The filter types that can be used here are discussed below. If none of these filters are used, all payouts in all states from within the last five years are returned: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]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. https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutStatus:{SUCCEEDED}https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutReference:{5********3}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=payoutDateImportant! 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.
EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "filter",
"in": "query",
"description": "The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect all payouts in all states that have occurred within the last five years: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]https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutStatus:{SUCCEEDED}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.
204 - No Content is returned instead.",
"operationId": "getSellerFundsSummary",
"parameters": [
{
"name": "X-EBAY-C-MARKETPLACE-ID",
"in": "header",
"description": "This header identifies the seller's eBay marketplace.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerFundsSummaryResponse"
}
}
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1100": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Insufficient permissions to fulfill the request."
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"135000": {
"domain": "API_FINANCES",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.finances"
],
"oauth2_api_scope_sell_finances": [
"https://api.ebay.com/oauth/api_scope/sell.finances",
"eBayUser"
]
}
]
}
},
"/transaction": {
"get": {
"tags": [
"transaction"
],
"description": "Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
SALE transactions for August 15, 2022;RETURN transactions for the month of January, 2021;transactionStatus equal to FUNDS_ON_HOLD.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "limit",
"in": "query",
"description": "The number of monetary transactions to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. 10 and limit is set to 10, the method retrieves monetary transactions 11 thru 20 from the result set. 0. 1000 20",
"required": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": true
},
{
"name": "offset",
"in": "query",
"description": "This integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10. 30 and limit is set to 10, the method retrieves transactions 31 thru 40 from the resulting collection of transactions. 5000. 0.0 (zero)",
"required": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": true
},
{
"name": "filter",
"in": "query",
"description": "Numerous filters are available for the getTransactions method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all monetary transactions occurring within the last five years are returned:YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234} https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8} https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE} https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3} https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutReference:{5*******3}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=transactionDateImportant! 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.
transactionStatus equal to FUNDS_ON_HOLD and the total monetary amount of these on-hold payments are also returned.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.EBAY_US is used.",
"required": true,
"schema": {
"type": "string",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"style": "simple",
"explode": false
},
{
"name": "filter",
"in": "query",
"description": "Numerous filters are available for the getTransactionSummary method, and these filters are discussed below. One or more of these filter types can be used. The transactionStatus filter must be used. All other filters are optional. https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234} https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8} https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE} https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-0***0-3***3} 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.
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.404 Not found.",
"operationId": "getTransfer",
"parameters": [
{
"name": "X-EBAY-C-MARKETPLACE-ID",
"in": "header",
"description": "This header identifies the seller's eBay marketplace.EBAY_US is used.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transfer_Id",
"in": "path",
"description": "This path parameter is used to specify the unique identifier of the TRANSFER transaction type you wish to retrieve.TRANSFER. The transfer_id value will then be returned in the transaction_id field of the response.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not found.",
"x-response-codes": {
"errors": {
"135012": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "The transfer ID was not found."
}
}
}
},
"500": {
"description": "Internal Server Error.",
"x-response-codes": {
"errors": {
"135000": {
"domain": "API_FINANCES",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.finances"
]
}
]
}
},
"/billing_activity": {
"get": {
"tags": [
"billing_activity"
],
"description": "Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
en-US.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "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.[start..end]filter=activityID:{12**56}filter=transactionDate:[2025-10-01T00:00:00Z..2025-10-31T23:59:59Z]",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Sets the maximum number of records to return per page of data.Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, with offset set to 20 and limit set to 10, the call retrieves entries 21 through 30 from the result set.
Although this field is optional, if omitted the default value of 100 is used.
1200100",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Specifies the number of records to skip in the result set. This is used with the limit field to control the pagination of the output. For example:0 and limit is 10, the method will retrieve records 1-10 from the list of records returned10 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=transactionDate. For example (ascending order):filter=transactionDate:[2025-11-01T00:00:01.000Z..2025-11-12T00:00:01.000Z]&sort=transactionDateEBAY_US is used.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/MarketplaceIdEnum"
}
},
{
"name": "payout_id",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "This path parameter is used to specify the unique identifier of the payout being retrieved.EBAY_US is used.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/MarketplaceIdEnum"
}
},
{
"name": "transfer_id",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "This path parameter is used to specify the unique identifier of the TRANSFER transaction type you wish to retrieve.TRANSFER. The transfer_id value will then be returned in the transaction_id field of the response."
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1001": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Invalid access token. Check the value of the Authorization HTTP request header."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"1100": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "Insufficient permissions to fulfill the request."
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"135012": {
"domain": "API_FINANCES",
"category": "REQUEST",
"description": "The transfer ID was not found."
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"x-response-codes": {
"errors": {
"135000": {
"domain": "API_FINANCES",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
}
}
}
}
},
"security": [
{
"oauth2_api_scope_sell_finances": [
"https://api.ebay.com/oauth/api_scope/sell.finances",
"eBayUser"
]
}
]
}
}
},
"components": {
"schemas": {
"Amount": {
"type": "object",
"required": [
"currency",
"value"
],
"description": "This type is used to express the dollar value and currency used for any transaction retrieved with the Finances API, including an order total, a seller payout, a buyer refund, or a seller credit.",
"properties": {
"convertedFromCurrency": {
"description": "The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.CNY.DEBIT or a CREDIT to the seller. Generally, all transfer transaction types are going to be DEBIT, since the money is being transferred from the seller to eBay.",
"$ref": "#/components/schemas/BookingEntryEnum"
}
}
},
"BillingActivityLineItem": {
"type": "object",
"required": [
"amount",
"billingTransactionDate",
"billingTransactionId",
"bookingEntry",
"feeType",
"feeTypeDescription"
],
"description": "This type defines the fees, credits, and promotional offers applied to a seller's account.",
"properties": {
"amount": {
"description": "This container shows the amount of the fee or credit. The value and currency are always returned. If the buyer is in one country and purchases from an eBay marketplace that uses a different currency, the response also includes the converted-from and converted-to fields, along with the exchange rate.",
"$ref": "#/components/schemas/Amount"
},
"billingTransactionDate": {
"type": "string",
"description": "This timestamp indicates the date/time when eBay processed the transaction."
},
"billingTransactionId": {
"type": "string",
"description": "This field provides a unique identifier of the billing transaction. If a seller wants to view details on a specific billing transaction, they can use the actvityId filter and pass in a specific billingTransactionId value."
},
"bookingEntry": {
"type": "string",
"description": "The value returned in this field will indicate if the billing transaction is a debit against the seller's account, or a credit. A debit is much more prevalent than a credit, but sometimes a listing fee will get reversed and they will get a credit for this fee. Possible values:DEBITCREDITFinalValueFeeFixedFeePerOrder."
},
"feeTypeDescription": {
"type": "string",
"description": "This field contains the human-readable description of the fee type associated with the transaction. For example, Final Value Fee."
},
"listingId": {
"type": "string",
"description": "The unique identifier of the eBay listing associated with the billing transaction. This field is returned if the fee is associated with a listing."
},
"orderId": {
"type": "string",
"description": "The unique identifier of the eBay order associated with the billing transaction. This field is returned if the fee is associated with an order."
},
"promotionalOffers": {
"type": "array",
"description": "A list of seller promotional offers applicable for the billing transaction.",
"items": {
"$ref": "#/components/schemas/DiscountDetail"
}
}
}
},
"BillingActivityResponse": {
"description": "This type is the base response type used by the getBillingActivities method. ",
"required": [
"billingActivities",
"count",
"limit",
"offset",
"total"
],
"type": "object",
"properties": {
"billingActivities": {
"type": "array",
"description": "A list of billing activity entries that meet the filter criteria. Billing activity will include fees, credits, and promotional offers applied to the seller's account.",
"items": {
"$ref": "#/components/schemas/BillingActivityLineItem"
}
},
"count": {
"type": "integer",
"description": "An integer representing the number of billing activity items returned in this response page.",
"format": "int32"
},
"limit": {
"type": "integer",
"description": "The value of the limit parameter. This is the maximum number of line items, as filtered, of billing transactions to return per page from the result set.",
"format": "int32"
},
"next": {
"type": "string",
"description": "The URI for the next page of results starting with the resource name. This URI is returned if there is an additional page of results in the result set."
},
"offset": {
"type": "integer",
"description": "The value of the offset parameter. This field indicates how many results were skipped in the response. If an offset parameter was not included in the request, this value will default to 0, returning the first page of results.",
"format": "int32"
},
"prev": {
"type": "string",
"description": "The URI for the previous page of results starting with the resource name. This URI is returned if there is a previous page of results in the result set."
},
"total": {
"type": "integer",
"description": "The total number of billing transactions available that match the filter criteria. Note: When the total value exceeds the limit value, there are multiple pages of results.
", "format": "int32" } } }, "BookingEntryEnum": { "type": "string", "description": "This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - **CREDIT**: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, theSALE and CREDIT transaction types are credits to the seller's account. For sales proceeds in the FUNDS_ON_HOLD state, the dollar value shown in the onHoldAmount will also show as seller credit. - **DEBIT**: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the REFUND, DISPUTE, SHIPPING_LABEL, and TRANSFER transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers.",
"enum": [
"CREDIT",
"DEBIT"
]
},
"Buyer": {
"type": "object",
"required": [
"username"
],
"description": "This type is used to express details about the buyer associated with an order. At this time, the only field in this type is the eBay user ID of the buyer, but more fields may get added at a later date.",
"properties": {
"username": {
"type": "string",
"description": "The eBay user ID of the order's buyer.ETRS (eBay Top Rated Seller) and PROMOTION."
}
}
},
"EarningsSummary": {
"type": "object",
"required": [
"grossAmount",
"orderEarnings"
],
"description": "This type defines a summarized view of earnings information derived from one order. It defines fields that provides a summarized view of earnings information derived from one order including aggregated financial values for gross amount, expenses, earnings, and refunds. ",
"properties": {
"expenses": {
"description": "This container provides the total expenses associated with an order, including:Note: Expenses are always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Expense" }, "grossAmount": { "description": "This container shows the gross amount before any eBay deductions. This amount includes the item subtotal, buyer-paid shipping and handling, and seller-collected tax paid by the buyer.Note: This amount does not include any taxes or fees that eBay collects from the buyer.
Note: Gross amount is always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" }, "orderEarnings": { "description": "This container shows your earnings after deducting expenses and any refunds from your gross amount.Note: Order earnings are always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" }, "refunds": { "description": "This container includes refunds for returns, cases, cancellations, requests, and disputes. It does not include fee credits.Note: Refunds are always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" } } }, "Error": { "type": "object", "required": [ "category", "domain", "errorId", "message" ], "description": "This type defines the fields that can be returned in an error.", "properties": { "category": { "type": "string", "description": "Identifies the type of error.", "$ref": "#/components/schemas/ErrorCategoryEnum" }, "domain": { "type": "string", "description": "Name for the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique number to identify the error.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A more detailed explanation of the error." }, "message": { "type": "string", "description": "Information on how to correct the problem, in the end user's terms and language where applicable." }, "outputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc." } } }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error." }, "value": { "type": "string", "description": "The value of the object." } } }, "Expense": { "type": "object", "description": "This type defines provides the total expenses associated with an order. Expenses represent cost components that reduce the seller's gross earnings and may include deductions such as marketplace fees, eBay shipping labels, and donations, applied during order processing.", "properties": { "currency": { "description": "This field shows the three-letter currency code that represents the currency used for all of the order expenses.", "$ref": "#/components/schemas/CurrencyCodeEnum" }, "donations": { "type": "array", "description": "This array shows the amount(s) of one or more donations that are submitted to eBay charity organizations for one or more orders.Note: Donations are always tied to specific items. When an item is listed with a charity contribution (for example, 10%), the donation is calculated per item at the time of sale. Order earnings factor in only the items within the order that are eligible for donation.
", "items": { "$ref": "#/components/schemas/OrderEarningFee" } }, "marketplaceFees": { "type": "array", "description": "This array shows the type and amount(s) of marketplace fees that were charged against one or more orders.", "items": { "$ref": "#/components/schemas/OrderEarningFee" } }, "shippingLabels": { "description": "This container shows the total amount paid by the seller for eBay shipping labels for one or more orders.Note: Charges and credits for shipping labels purchased with non-eBay payment methods (for example, PayPal) are excluded from the order earnings calculation.
", "$ref": "#/components/schemas/Amount" }, "value": { "type": "string", "description": "This field shows the total expenses including charges and credits associated for one or more orders based on the order creation time period chosen." } } }, "Fee": { "type": "object", "description": "This type is used for provide information about a fee that is charged against an order.", "properties": { "amount": { "description": "The monetary amount charged for the fee.", "$ref": "#/components/schemas/Amount" }, "feeJurisdiction": { "description": "This type defines the jurisdiction associated with a fee. It identifies the geographic or regulatory context under which a specific fee is applied to an order.", "$ref": "#/components/schemas/FeeJurisdiction" }, "feeMemo": { "type": "string", "description": "A descriptive message that provides additional context about the fee applied to the order." }, "feeType": { "description": "The enumeration value returned here indicates the type of fee that was deducted from the seller payout.", "$ref": "#/components/schemas/FeeTypeEnum" } } }, "FeeJurisdiction": { "type": "object", "description": "This type defines the jurisdiction information associated with a fee, identifying the geographic or regulatory region under which the fee is applied.", "properties": { "regionName": { "type": "string", "description": "The name of the region to which the fee applies.true, the filter criterion is negated (results that do NOT match the criterion are returned)."
},
"range": {
"$ref": "#/components/schemas/RangeValue"
},
"set": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of string values to filter on. Results matching any value in this set are returned."
},
"value": {
"type": "string",
"description": "A single string value to filter on."
}
},
"description": "This type defines a single filter criterion, including the field name, an optional value or set of values, an optional date or numeric range, and an optional negation flag."
},
"FundingSource": {
"type": "object",
"description": "This type defines the source of funds used to finance a transfer, such as available seller funds, a credit card, or a bank account.",
"properties": {
"brand": {
"type": "string",
"description": "The brand name of the credit card or the name of the financial institution that is the source of payment. This field may not be populated for other funding sources."
},
"memo": {
"type": "string",
"description": "This field provides a note about the funding source. If the seller's credit card or bank account is the funding source, this field might contain the last four digits of the credit card or bank account. This field may also be returned as null."
},
"type": {
"type": "string",
"description": "The string value returned here indicates the funding source. Possible values include the following:AVAILABLE_FUNDS: transfer is funded with seller payout fundsCREDIT_CARD: transfer is funded with seller's credit cardBANK: transfer is funded with a direct debit to seller's bank account on file with eBayPAY_UPON_INVOICE: eBay will bill the seller for the transfer on the monthly invoiceNote: Expenses are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" }, "grossAmount": { "description": "The aggregate gross amount for all orders included in the order earnings summary. This amount equals the item subtotal plus shipping and handling, and any seller-collected taxes paid by the buyer, minus any seller-offered discount.Note: Gross amount is always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" }, "orderCount": { "type": "integer", "description": "The total number of orders included in the summary.", "format": "int64" }, "orderEarnings": { "description": "The aggregate earnings amount for all orders included in the summary, which includes the amount of order earnings after deducting expenses and any refunds from the gross amount.Note: Order earnings are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" }, "refunds": { "description": "The aggregate amount of all refunds issued for the orders included in the summary.Note: Refunds include gross refunds, gross claims, and gross payment disputes.
Note: Refunds are always in the seller's payout currency. Conversion-related fields (such as exchangeRate) in this container do not apply to the order_earnings resource.
", "$ref": "#/components/schemas/Amount" } } }, "OrderLineItem": { "type": "object", "description": "This type is used to show the fees and donations that are deducted from a seller payout for each line item in an order.", "properties": { "donations": { "type": "array", "description": "The list of donations applied to the line item.RETRYABLE_FAILED or TERMINAL_FAILED. A seller can filter on the lastAttemptedPayoutDate in a getPayouts request."
},
"payoutDate": {
"type": "string",
"description": "This timestamp indicates when the seller payout began processing. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z. This field is still returned even if the payout was pending but failed (payoutStatus value shows RETRYABLE_FAILED or TERMINAL_FAILED)."
},
"payoutId": {
"type": "string",
"description": "The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account."
},
"payoutInstrument": {
"description": "This container provides details about the seller's account that received (or is scheduled to receive) the payout. This container is still returned even if the payout failed.",
"$ref": "#/components/schemas/PayoutInstrument"
},
"payoutMemo": {
"type": "string",
"description": "This field contains information provided by upstream components, based on internal and external commitments. A typical message would contain the expected arrival time of the payout."
},
"payoutReference": {
"type": "string",
"description": "This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout ID(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account. SUCCEEDED. See the PayoutStatusEnum type for more details on each payout status value.",
"$ref": "#/components/schemas/PayoutStatusEnum"
},
"payoutStatusDescription": {
"type": "string",
"description": "This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the payoutStatus field. The following shows what description text might appear based on the different payoutStatus values:INITIATED: Preparing to sendSUCCEEDED: Funds sentREVERSED: Waiting to retry : Money rejected by seller's bankRETRYABLE_FAILED: Waiting to retryTERMINAL_FAILED: Payout failedEXPRESS_PAYOUT_FEE charged by eBay. The is expressed as a numeric value and the currency used.",
"$ref": "#/components/schemas/Amount"
},
"totalFee": {
"description": "This container indicates the amount of the EXPRESS_PAYOUT_FEE charged by eBay when a seller requests payout to a debit card. The fee is expressed as a numeric value and the currency used.",
"$ref": "#/components/schemas/Amount"
},
"totalFeeDetails": {
"type": "array",
"description": "This array indicates all payout fees associated with a payout, including the fee type, amount, value, and currency.",
"items": {
"$ref": "#/components/schemas/Fee"
}
},
"transactionCount": {
"type": "integer",
"description": "This integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least 1, since there is at least one order per seller payout.2 instead of 1.BANK: indicates that the payout was made to a seller's bank account.CARD: indicates that the payout went to a seller's debit cardPAYONEER)BANK, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.CARD, this value is the debit card network for the debit card that receives the payout.PAYONEER).50 indicates that 50% of the payout goes to the instrument.0).",
"format": "int64"
},
"transactionCount": {
"type": "integer",
"description": "This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0). If there is at least one payout that matches the input criteria, the value in this field will be at least 1.",
"format": "int64"
}
}
},
"Payouts": {
"type": "object",
"required": [
"href",
"limit",
"offset",
"payouts",
"total"
],
"description": "This type is the base response type of the getPayouts method, and contains an array of one or more payouts (that match the input criteria), the total count of payouts in the response, and various pagination data for the results set.",
"properties": {
"href": {
"type": "string",
"description": "The URI of the getPayouts call request that produced the current page of the result set."
},
"limit": {
"type": "integer",
"description": "The maximum number of payouts that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20. 120 (120 total payouts) and the limit value was 50 (show 50 payouts per page), the total number of pages in the result set is three, so the seller would have to make three separate getPayouts calls to view all payouts matching the input criteria. 200 20",
"format": "int64"
},
"next": {
"type": "string",
"description": "The getPayouts call URI to use if you wish to view the next page of the result set. 10. 30 and limit is set to 10, the call retrieves payouts 31 thru 40 from the resulting collection of payouts. 0.0 (zero)",
"format": "int64"
},
"payouts": {
"type": "array",
"description": "An array of one or more payouts that match the input criteria. Details for each payout include the unique identifier of the payout, the status of the payout, the amount of the payout, and the number of monetary transactions associated with the payout.",
"items": {
"$ref": "#/components/schemas/Payout"
}
},
"prev": {
"type": "string",
"description": "The getPayouts call URI to use if you wish to view the previous page of the result set. true, the end value is excluded from the range."
},
"exclusiveStart": {
"type": "boolean",
"description": "When set to true, the start value is excluded from the range."
},
"start": {
"type": "string",
"description": "The start value of the range (inclusive by default)."
}
},
"description": "This type defines a range of values used for date or numeric filtering, with optional exclusive bounds for the start and end of the range."
},
"Reference": {
"type": "object",
"description": "This field is returned for NON_SALE_CHARGE transactions that contain non-transactional seller fees.",
"properties": {
"referenceId": {
"type": "string",
"description": "The identifier of the transaction as specified by the referenceType. For example, with a referenceType of item_id, the referenceId refers to a unique item. This item may have several NON_SALE_CHARGE transactions."
},
"referenceType": {
"description": "An enumeration value that identifies the reference type associated with the referenceId.",
"$ref": "#/components/schemas/ReferenceTypeEnum"
}
}
},
"RegionTypeEnum": {
"type": "string",
"description": "An enumerated value indicating the type of governing jurisdiction requiring the fee to be deducted from a seller's payout. | - **COUNTRY**: Indicates the governing jurisdiction is a country. - **STATE_OR_PROVINCE**: Indicates the governing jurisdiction is a state or province.",
"enum": [
"STATE_OR_PROVINCE",
"COUNTRY"
]
},
"SellerFundsSummaryResponse": {
"type": "object",
"required": [
"availableFunds",
"fundsOnHold",
"processingFunds"
],
"description": "This type is used by the response payload of the getSellerFundsSummary method. All of the funds returned in getSellerFundsSummary are funds that have not yet been paid to the seller through a seller payout. If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content is returned instead.",
"properties": {
"availableFunds": {
"description": "This field represents the total amount of order funds that are available for a payout, but processing for a seller payout has not yet begun. If a seller wants to get more details on sales transactions that have yet to be processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_AVAILABLE_FOR_PAYOUT.FUNDS_ON_HOLD.FUNDS_PROCESSING.204 - No Content status code will be returned along with an empty payload.",
"$ref": "#/components/schemas/Amount"
}
}
},
"SortField": {
"type": "object",
"properties": {
"ascending": {
"type": "boolean",
"description": "When set to true, results are sorted in ascending order. When false or omitted, results are sorted in descending order (most recent first)."
},
"field": {
"type": "string",
"description": "The name of the field to sort by."
}
},
"description": "This type defines the sort criterion for a collection of resources, specifying the field to sort on and the sort direction."
},
"Tax": {
"type": "object",
"description": "This type defines tax information associated with a transaction.",
"properties": {
"taxType": {
"description": "The type of tax applied to the transaction.",
"$ref": "#/components/schemas/TaxTypeEnum"
},
"amount": {
"description": "The monetary amount of the tax applied.",
"$ref": "#/components/schemas/Amount"
}
}
},
"TaxTypeEnum": {
"type": "string",
"description": "This enumerated type lists the type of taxes that can be charged against monetary transactions. | - **VAT**: VAT is Value-Added Tax. ",
"enum": [
"VAT"
]
},
"TransactionStatusEnum": {
"type": "string",
"description": "This enumeration type lists the different possible states of a monetary transaction, including payouts to sellers, refunds to buyers, and credits to a seller's account. Note: The enumerations COMPLETED and FAILED apply to monetary transactions with the transactionType of TRANSFER. They only apply to monetary transactions where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
20. 120 (120 total monetary transactions) and the limit value was 50 (show 50 monetary transactions per page), the total number of pages in the result set is three, so the seller would have to make three separate getTransactions calls to view all monetary transactions matching the input criteria. 200 20",
"format": "int64"
},
"next": {
"type": "string",
"description": "The getTransactions method URI to use if you wish to view the next page of the result set. 10. 30 and limit is set to 10, the method retrieves monetary transactions 31 thru 40 from the resulting collection of monetary transactions. 0.0 (zero)",
"format": "int64"
},
"prev": {
"type": "string",
"description": "The getTransactions method URI to use if you wish to view the previous page of the result set. TRANSFER transaction type that is returned in the response.",
"properties": {
"fundingSource": {
"description": "This container provides details about the seller's funding source to reimburse eBay for the transfer, such as a bank account, a credit card, or available seller payout funds.",
"$ref": "#/components/schemas/FundingSource"
},
"transactionDate": {
"type": "string",
"description": "This timestamp indicates the date/time of the transfer. The following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2020-08-04T19:09:02.768Z"
},
"transferAmount": {
"description": "The amount of the transfer being deducted from the funding source.",
"$ref": "#/components/schemas/Amount"
},
"transferDetail": {
"description": "This container provides more details about the transfer, including details on the charge(s) associated with the transfer. Multiple charges can be addressed with one transfer.",
"$ref": "#/components/schemas/TransferDetail"
},
"transferId": {
"type": "string",
"description": "The unique identifier of the TRANSFER transaction type. This is the same value that was passed into the end of the call URI."
}
}
},
"TransferDetail": {
"type": "object",
"description": "This type is used by the transferDetail container, which provides more details about the transfer and the charge(s) associated with the transfer.",
"properties": {
"balanceAdjustment": {
"description": "This container shows the seller payout balance that will be applied toward the charges outlined in the charges array.",
"$ref": "#/components/schemas/BalanceAdjustment"
},
"charges": {
"type": "array",
"description": "This container is an array of one or more charges related to the transfer. Charges can be related to an order cancellation, order return, case, payment dispute, etc.",
"items": {
"$ref": "#/components/schemas/Charge"
}
},
"totalChargeNetAmount": {
"description": "This container shows the total amount that the seller owes for all of the charges outlined in the charges array.",
"$ref": "#/components/schemas/Amount"
}
}
},
"ErrorCategoryEnum": {
"type": "string",
"enum": [
"APPLICATION",
"BUSINESS",
"REQUEST"
],
"description": "This enumerated type identifies the category of an error returned in the response.\n| - **APPLICATION**: Indicates a server-side application error.\n- **BUSINESS**: Indicates that the error is due to a business rule violation.\n- **REQUEST**: Indicates that the error is caused by an invalid or missing value in the request."
},
"MarketplaceIdEnum": {
"type": "string",
"description": "Defines the list of valid eBay marketplaces.",
"enum": [
"EBAY_US",
"EBAY_CA",
"EBAY_GB",
"EBAY_AU",
"EBAY_AT",
"EBAY_BE",
"EBAY_DE",
"EBAY_IT",
"EBAY_NL",
"EBAY_ES",
"EBAY_CH",
"EBAY_TW",
"EBAY_CZ",
"EBAY_DK",
"EBAY_FI",
"EBAY_FR",
"EBAY_GR",
"EBAY_HK",
"EBAY_HU",
"EBAY_IN",
"EBAY_ID",
"EBAY_IE",
"EBAY_IL",
"EBAY_MY",
"EBAY_NZ",
"EBAY_NO",
"EBAY_PH",
"EBAY_PL",
"EBAY_PT",
"EBAY_PR",
"EBAY_RU",
"EBAY_SG",
"EBAY_ZA",
"EBAY_SE",
"EBAY_TH",
"EBAY_VN",
"EBAY_CN",
"EBAY_JP",
"EBAY_PE",
"EBAY_MOTORS_US"
]
},
"ReferenceTypeEnum": {
"type": "string",
"description": "An enumerated type that identifies the type of reference ID provided. | - **CANCELLATION_ID**: This enumeration value indicates that the ID provided refers to the unique identifier of a cancellation. - **CASE_ID**: This enumeration value indicates that the ID provided refers to the unique identifier of a case. - **INVOICE**: This enumeration value indicates that the ID provided refers to the unique identifier of an invoice. It indicates that the seller will be billed by invoice, and fees will not be deducted from the payout.NON_SALE_CHARGE transactions. - **ITEM_ID**: This enumeration value indicates that the ID provided refers to the unique identifier of an item. It is used to identify listing-related fees.FINAL_VALUE_FEE, and is based on a percentage of the order line item cost. - **BELOW_STANDARD_SHIPPING_FEE**: This fee is charged to Below Standard sellers in addition to the FINAL_VALUE_FEE, and is based on a percentage of the shipping cost for an order line item.BELOW_STANDARD_FEE and not returned separately. - **FINAL_VALUE_FEE_FIXED_PER_ORDER**: This fee is a fixed-cost fee charged by eBay for every order (regardless of how many line items are in the order). This fee can vary by country. - **FINAL_VALUE_FEE**: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the order line item cost. The percentage varies by eBay category. - **INTERNATIONAL_FEE**: This fee is an international fee associated with an order line item if the seller's eBay registered address country is different than the buyer's registered address or delivery address. This fee is calculated as a percentage of the total amount of the order line item. - **HIGH_ITEM_NOT_AS_DESCRIBED_FEE**: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the order line item cost. - **HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE**: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the shipping cost for the order line item.HIGH_ITEM_NOT_AS_DESCRIBED_FEE and not returned separately. - **PAYMENT_PROCESSING_FEE**: This is a payment processing fee charged for each order.FINAL_VALUE_FEE_FIXED_PER_ORDER and not returned separately. - **FINAL_VALUE_SHIPPING_FEE**: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the shipping cost for the order line item. The percentage varies by eBay category.FINAL_VALUE_FEE and not returned separately. - **INSERTION_FEE**: This enumeration value indicates that the account entry is an insertion fee for a listing. - **BOLD_FEE**: This enumeration value indicates that the account entry is a listing upgrade fee or credit for a listing title in boldface font. - **FINANCE_FEE**: This enumeration value indicates that the account entry is a finance charge to the user's account. - **CATEGORY_FEATURED_FEE**: This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.EXPRESS_PAYOUT_FEE will be credited back to the seller's account. - **TAX_DEDUCTION_AT_SOURCE**: This enumeration value indicates the account entry is the tax amount automatically deducted from a seller's payout. - **INCOME_TAX_WITHHOLDING**: This enumeration value indicates the account entry is the required income tax amount deducted from a seller's payout. - **VAT_WITHHOLDING**: This enumeration value indicates that the account entry is the required VAT amount deducted from the seller's payout. - **BANK_PAYOUT_FEE**: This enumeration value indicates that a fee is charged by eBay when a seller requests a payout through a bank account.BANK_PAYOUT_FEE is only applicable for CNY sellers and when the payoutInstrumentType is BANK. - **CHARITY_DONATION**: This enumeration value indicates the charitable donations against a sale. - **REGULATORY_OPERATING_FEE**: This enumeration value indicates that a fee is charged by eBay to cover the costs associated with complying with regulatory requirements in specific marketplaces. - **OTHER_FEES**: This enumeration value may be returned if the fee type cannot be determined, or has not been classified.",
"enum": [
"BELOW_STANDARD_FEE",
"BELOW_STANDARD_SHIPPING_FEE",
"FINAL_VALUE_FEE_FIXED_PER_ORDER",
"FINAL_VALUE_FEE",
"INTERNATIONAL_FEE",
"HIGH_ITEM_NOT_AS_DESCRIBED_FEE",
"HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE",
"PAYMENT_PROCESSING_FEE",
"FINAL_VALUE_SHIPPING_FEE",
"INSERTION_FEE",
"BOLD_FEE",
"FINANCE_FEE",
"CATEGORY_FEATURED_FEE",
"NSFCHECK_FEE",
"PROMOTIONAL_CREDIT",
"GALLERY_FEE",
"FEATURED_GALLERY_FEE",
"RESERVE_PRICE_FEE",
"IPIXPHOTO_FEE",
"LARGE_PICTURE_FEE",
"EBAY_STORE_SUBSCRIPTION_FEE",
"BUY_IT_NOW_FEE",
"SUBTITLE_FEE",
"INTERNATIONAL_LISTING_FEE",
"PRO_PACK_BUNDLE_FEE",
"MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE",
"VEHICLE_LOCAL_SUBSCRIPTION_FEE",
"VEHICLE_LOCAL_INSERTION_FEE",
"VALUE_PACK_BUNDLE_FEE",
"PRO_PACK_PLUS_BUNDLE_FEE",
"GALLERY_PLUS_FEE",
"EBAY_MOTORS_PRO_FEE",
"PRIVATE_LISTING_FEE",
"AUCTION_END_EARLY_FEE",
"STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE",
"AD_FEE",
"EBAY_PLUS_SUBSCRIPTION_FEE",
"VEHICLE_SUBSCRIPTION_FEE",
"CO_FUNDING_COUPON_FEE",
"PAYMENT_DISPUTE_FEE",
"PREMIUM_AD_FEES",
"VEHICLES_BASIC_PACKAGE_FEE",
"VEHICLES_PLUS_PACKAGE_FEE",
"VEHICLES_PREMIUM_PACKAGE_FEE",
"DEPOSIT_PROCESSING_FEE",
"EXPRESS_PAYOUT_FEE",
"TAX_DEDUCTION_AT_SOURCE",
"INCOME_TAX_WITHHOLDING",
"VAT_WITHHOLDING",
"BANK_PAYOUT_FEE",
"CHARITY_DONATION",
"REGULATORY_OPERATING_FEE",
"OTHER_FEES"
]
},
"Transaction": {
"type": "object",
"required": [
"amount",
"bookingEntry",
"salesRecordReference",
"transactionDate",
"transactionId",
"transactionStatus",
"transactionType"
],
"description": "This type is used to express the details of one of the following monetary transactions: a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account.",
"properties": {
"amount": {
"description": "This container shows the dollar value and currency type of the monetary transaction. This field is always returned even when eBay has yet to initiate a payout for the order.",
"$ref": "#/components/schemas/Amount"
},
"bookingEntry": {
"description": "The enumeration value returned in this field indicates if the monetary transaction amount is a (CREDIT) or a (DEBIT) to the seller's account.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"buyer": {
"description": "This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER monetary transaction types.",
"$ref": "#/components/schemas/Buyer"
},
"eBayCollectedTaxAmount": {
"description": "This is the amount of sales tax that has been collected by eBay for an order.SALE and REFUND transactions (transactionType).",
"$ref": "#/components/schemas/Amount"
},
"feeJurisdiction": {
"description": "This container stores information about region-specific fees that are charged to sellers.",
"$ref": "#/components/schemas/FeeJurisdiction"
},
"feeType": {
"description": "The enumeration value returned in this field indicates the type of fee that was deducted from the seller payout.",
"$ref": "#/components/schemas/FeeTypeEnum"
},
"orderId": {
"type": "string",
"description": "The unique identifier of the eBay order associated with the monetary transaction."
},
"orderLineItems": {
"type": "array",
"description": "This array either shows the order line item transactional fees related to a SALE transaction and deducted from the payout associated with that order, or it shows the transactional fee credits going back to the seller in the case of a REFUND transaction.",
"items": {
"$ref": "#/components/schemas/OrderLineItem"
}
},
"paymentsEntity": {
"type": "string",
"description": "This string value indicates the entity that is processing the payment."
},
"payoutDetails": {
"description": "This container provides the payout details for a split-payout case. This container is only returned for split-payout use cases.",
"$ref": "#/components/schemas/PayoutDetails"
},
"payoutId": {
"type": "string",
"description": "The unique identifier of the seller payout associated with the monetary transaction."
},
"references": {
"type": "array",
"description": "This field contains reference information for the transaction fee. This includes an ID and the type of ID provided (such as item ID).",
"items": {
"$ref": "#/components/schemas/Reference"
}
},
"salesRecordReference": {
"type": "string",
"description": "The Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout.0 will be returned in this field. The Sales Record Number field has also been removed from Seller Hub. Instead of salesRecordReference, depend on orderId instead as the identifier of the order. The salesRecordReference field has been scheduled for deprecation, and a date for when this field will no longer be returned at all will be announced soon."
},
"taxes": {
"type": "array",
"description": "This array shows the tax type and amount applicable to the transaction. YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z."
},
"transactionId": {
"type": "string",
"description": "This field, when combined with the transactionType field, provide a unique identifier of the monetary transaction."
},
"transactionMemo": {
"type": "string",
"description": "This field applies to shipping label transactions, sales transactions where payout is on hold, and non-sale charge fees."
},
"transactionStatus": {
"description": "This enumeration value indicates the current status of the seller payout associated with the monetary transaction.",
"$ref": "#/components/schemas/TransactionStatusEnum"
},
"transactionType": {
"description": "This enumeration value indicates the type of monetary transaction.",
"$ref": "#/components/schemas/TransactionTypeEnum"
},
"ebayCollectedTaxAmount": {
"$ref": "#/components/schemas/Amount",
"description": "Sales tax collected by eBay, applicable only for SALE and REFUND."
}
}
},
"TransactionSummaryResponse": {
"type": "object",
"description": "This type is the base response type of the getTransactionSummary method, and based on the filters that are used in the getTransactionSummary call URI, the response may include total count and amount of the seller's sales and credits, total count and amount of buyer refunds, and total count and amount of seller payment holds.",
"properties": {
"adjustmentAmount": {
"description": "Total adjustment amount for given payee within a specified period.",
"$ref": "#/components/schemas/Amount"
},
"adjustmentBookingEntry": {
"description": "The credit debit sign indicator for adjustment.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"adjustmentCount": {
"type": "integer",
"description": "Total adjustment count for given payee within a specified period.",
"format": "int64"
},
"balanceTransferAmount": {
"description": "The total balance transfer amount for given payee within the specified period.",
"$ref": "#/components/schemas/Amount"
},
"balanceTransferBookingEntry": {
"description": "The credit debit sign indicator for the balance transfer.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"balanceTransferCount": {
"type": "integer",
"description": "The total balance transfer count for given payee within the specified period.",
"format": "int64"
},
"creditAmount": {
"description": "This amount is the total dollar value of all the seller's sales and/or credits that match the input criteria.",
"$ref": "#/components/schemas/Amount"
},
"creditBookingEntry": {
"description": "The enumeration value indicates whether the dollar amount in the creditAmount field is a charge (debit) to the seller or a credit.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"creditCount": {
"type": "integer",
"description": "This integer value indicates the total number of the seller's sales and/or credits that match the input criteria.",
"format": "int64"
},
"disputeAmount": {
"description": "This amount is the total dollar value associated with any existing payment disputes.",
"$ref": "#/components/schemas/Amount"
},
"disputeBookingEntry": {
"description": "The enumeration value indicates whether the dollar amount in the disputeAmount field is a charge (debit) to the seller or a credit.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"disputeCount": {
"type": "integer",
"description": "This integer value indicates the total number of payment disputes.",
"format": "int64"
},
"loanRepaymentAmount": {
"description": "The sum of all LOAN_REPAYMENT transactions (i.e., debit and credit,) that match the input criteria.",
"$ref": "#/components/schemas/Amount"
},
"loanRepaymentBookingEntry": {
"description": "The enumeration value indicates whether the loanRepaymentAmount is a DEBIT against, or a CREDIT to, the sellers's account.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"loanRepaymentCount": {
"type": "integer",
"description": "This integer value indicates the total number of LOAN_REPAYMENT transactions.",
"format": "int64"
},
"nonSaleChargeAmount": {
"description": "The total non-sale charge amount for given payee within a specified period.",
"$ref": "#/components/schemas/Amount"
},
"nonSaleChargeBookingEntry": {
"description": "The credit/debit sign indicator for the non-sale charge.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"nonSaleChargeCount": {
"type": "integer",
"description": "The total non-sale charge count for given payee within a specified period.",
"format": "int64"
},
"onHoldAmount": {
"description": "This amount is the total dollar value of order sales where the associated funds are on hold.",
"$ref": "#/components/schemas/Amount"
},
"onHoldBookingEntry": {
"description": "The enumeration value indicates whether the dollar amount in the onHoldAmount field is a charge (debit) to the seller or a credit.",
"$ref": "#/components/schemas/BookingEntryEnum"
},
"onHoldCount": {
"type": "integer",
"description": "This integer value indicates the total number of order sales where the associated funds are on hold.",
"format": "int64"
},
"purchaseAmount": {
"description": "Note: The PURCHASE transaction type is currently only applicable in the US marketplace.