{ "openapi": "3.0.0", "info": { "title": "eBay Finances API", "description": "This API is used to retrieve seller payouts and monetary transaction details related to those payouts.", "contact": { "name": "eBay Inc," }, "license": { "name": "eBay API License Agreement", "url": "https://go.developer.ebay.com/api-license-agreement" }, "version": "v1.17.1" }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/finances/v1" } } } ], "paths": { "/payout/{payout_Id}": { "get": { "tags": [ "payout" ], "description": "
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
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"
}
},
{
"name": "filter",
"in": "query",
"description": "The filter types that can be used here are discussed below. If none of these filters are used, all recent payouts in all states are returned: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:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]
RETRYABLE_FAILED
. The date format to use is YYYY-MM-DDTHH:MM:SS.SSSZ
. The same syntax used for the payoutDate filter is also used for 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}
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": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10
. 30
and limit is set to 10
, the method retrieves payouts 31 thru 40 from the resulting collection of payouts. 0
.0
(zero)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "By default, payouts or failed payouts that match the input criteria are sorted in descending order according to the payout date/last attempted payout date (i.e., most recent payouts returned first).payoutDate
or lastAttemptedPayoutDate
(if searching for failed, retryable payouts). Below is the proper syntax to use if filtering by a payout date range in ascending order:https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]&sort=payoutDate
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": "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 previous payouts in all states: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:[2018-12-17T00:00:01.000Z..2018-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"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerFundsSummaryResponse"
}
}
}
},
"204": {
"description": "No Content"
},
"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"
]
}
]
}
},
"/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"
}
},
{
"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 previous monetary transactions 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:[2018-10-23T00:00:01.000Z..2018-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=salesRecordReference:{123}
0
will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date. 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}
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": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "This integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10
. 30
and limit is set to 10
, the method retrieves transactions 31 thru 40 from the resulting collection of transactions. 0
.0
(zero)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "By default, monetary transactions that match the input criteria are sorted in descending order according to the transaction date (i.e, most recent transactions returned first).transactionDate
. Below is the proper syntax to use if filtering by a transaction date range in ascending order:https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2023-10-01T00:00:01.000Z..2023-10-12T00:00:01.000Z]&sort=transactionDate
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.
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.",
"operationId": "getTransactionSummary",
"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": "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:[2018-10-23T00:00:01.000Z..2018-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=salesRecordReference:{123}
0
will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date. 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"
]
}
]
}
}
},
"components": {
"schemas": {
"Amount": {
"type": "object",
"properties": {
"convertedFromCurrency": {
"type": "string",
"description": "The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.CNY
.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field. DEBIT
or a CREDIT
to the seller. Generally, all transfer transaction types are going to be DEBIT
, since the money is being tranferred from the seller to eBay. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used by the balanceAdjustment container, which shows the seller payout balance that will be applied toward the charges outlined in the charges array."
},
"Buyer": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The eBay user ID of the order's buyer."
}
},
"description": "This type is used to express details about the buyer associated with an order. At this time, the only field in this type is the eBay user ID of the buyer, but more fields may get added at a later date."
},
"Charge": {
"type": "object",
"properties": {
"cancellationId": {
"type": "string",
"description": "The unique identifier of an order cancellation. This field is only applicable and returned if the charge is related to an order cancellation."
},
"caseId": {
"type": "string",
"description": "The unique identifier of a case filed against an order. This field is only applicable and returned if the charge is related to a case filed against an order."
},
"chargeNetAmount": {
"description": "This container shows the net amount of the charge, which is the total amount of the charge minus the total amount of fees credited towards this refund as per eBay policy. It is possible for there to be multiple charges from multiple orders with one transfer. The net aggregate amount for all charges found in the charges array can be found in the transferDetail.totalChargeNetAmount container.",
"$ref": "#/components/schemas/Amount"
},
"inquiryId": {
"type": "string",
"description": "The unique identifier of an Item Not Received (INR) inquiry filed against an order. This field is only applicable and returned if the charge is related to has an INR inquiry filed against the order."
},
"orderId": {
"type": "string",
"description": "The unique identifier of the order that is associated with the charge."
},
"paymentDisputeId": {
"type": "string",
"description": "The unique identifier of a third-party payment dispute filed against an order. This occurs when the buyer files a dispute against the order with their payment provider, and then the dispute comes into eBay's system. This field is only applicable and returned if the charge is related to a third-party payment dispute filed against an order."
},
"refundId": {
"type": "string",
"description": "The unique identifier of a buyer refund associated with the charge."
},
"returnId": {
"type": "string",
"description": "The unique identifier of an order return. This field is only applicable and returned if the charge is related to an order that was returned by the buyer."
}
},
"description": "This type is used by the charge container, which is an array of one or more charges related to the transfer."
},
"Error": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Identifies the type of erro."
},
"domain": {
"type": "string",
"description": "Name for the primary system where the error occurred. This is relevant for application errors."
},
"errorId": {
"type": "integer",
"description": "A unique number to identify the error.",
"format": "int32"
},
"inputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"longMessage": {
"type": "string",
"description": "A more detailed explanation of the error."
},
"message": {
"type": "string",
"description": "Information on how to correct the problem, in the end user's terms and language where applicable."
},
"outputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"parameters": {
"type": "array",
"description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
},
"subdomain": {
"type": "string",
"description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
}
},
"description": "This type defines the fields that can be returned in an error."
},
"ErrorParameter": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The object of the error."
},
"value": {
"type": "string",
"description": "The value of the object."
}
}
},
"Fee": {
"type": "object",
"properties": {
"amount": {
"description": "The amount of the fee.",
"$ref": "#/components/schemas/Amount"
},
"feeJurisdiction": {
"description": "Indicates the specific jurisdiction for the fee that has been deducted from the seller payout.",
"$ref": "#/components/schemas/FeeJurisdiction"
},
"feeMemo": {
"type": "string",
"description": "A description of the fee that was deducted from the seller payout."
},
"feeType": {
"type": "string",
"description": "The enumeration value returned here indicates the type of fee that was deducted from the seller payout. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used to display fees that are automatically deducted from seller payouts."
},
"FeeJurisdiction": {
"type": "object",
"properties": {
"regionName": {
"type": "string",
"description": "String value that indicates the name of the region to which a region-specific fee applies.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 invoiceRETRYABLE_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. For implementation help, refer to eBay API documentation"
},
"payoutStatusDescription": {
"type": "string",
"description": "This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the payoutStatus field. The following shows what description text might appear based on the different payoutStatus values:INITIATED
: Preparing to 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": "int32"
},
"transactionCount": {
"type": "integer",
"description": "This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0
). If there is at least one payout that matches the input criteria, the value in this field will be at least 1
.",
"format": "int32"
}
},
"description": "This type is the base response type of the getPayoutSummary method, and contains the total count of seller payouts (that match the input criteria), the total count of monetary transactions (order payment, buyer refunds, or seller credits) associated with those payouts, and the total value of those seller payouts."
},
"Payouts": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URI of the getPayouts call request that produced the current page of the result set."
},
"limit": {
"type": "integer",
"description": "The maximum number of payouts that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20
. 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": "int32"
},
"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": "int32"
},
"payouts": {
"type": "array",
"description": "An array of one or more payouts that match the input criteria. Details for each payout include the unique identifier of the payout, the status of the payout, the amount of the payout, and the number of monetary transactions associated with the payout.",
"items": {
"$ref": "#/components/schemas/Payout"
}
},
"prev": {
"type": "string",
"description": "The getPayouts call URI to use if you wish to view the previous page of the result set. NON_SALE_CHARGE
transactions."
},
"referenceType": {
"type": "string",
"description": "An enumeration value that identifies the reference type associated with the referenceId. For implementation help, refer to eBay API documentation"
}
},
"description": "This field is returned for NON_SALE_CHARGE transactions that contain non-transactional seller fees."
},
"SellerFundsSummaryResponse": {
"type": "object",
"properties": {
"availableFunds": {
"description": "This field represents the total amount of order funds that are available for a payout, but processing for a seller payout has not yet begun. If a seller wants to get more details on sales transactions that have yet to be processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_AVAILABLE_FOR_PAYOUT
.FUNDS_ON_HOLD
.FUNDS_PROCESSING
.204 - No Content
status code will be returned along with an empty payload.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type is used by the response payload of the getSellerFundsSummary method. All of the funds returned in getSellerFundsSummary are funds that have not yet been paid to the seller through a seller payout. If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content
is returned instead."
},
"Tax": {
"type": "object",
"properties": {
"taxType": {
"type": "string",
"description": "The enumeration value returned here indicates the type of tax. For implementation help, refer to eBay API documentation"
},
"amount": {
"description": "Amount of tax.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type is used to return the tax details of a transaction."
},
"Transaction": {
"type": "object",
"properties": {
"amount": {
"description": "This container shows the dollar value and currency type of the monetary transaction. This field is always returned even when eBay has yet to initiate a payout for the order.",
"$ref": "#/components/schemas/Amount"
},
"bookingEntry": {
"type": "string",
"description": "The enumeration value returned in this field indicates if the monetary transaction amount is a (CREDIT
) or a (DEBIT
) to the seller's account. Typically, the SALE
and CREDIT
transaction types are credits to the seller's account, and the REFUND
, DISPUTE
, SHIPPING_LABEL
, and TRANSFER
transaction types are debits to the seller's account. For implementation help, refer to eBay API documentation"
},
"buyer": {
"description": "This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER
monetary transaction types.",
"$ref": "#/components/schemas/Buyer"
},
"eBayCollectedTaxAmount": {
"description": "This is the amount of sales tax that has been collected by eBay for an order.SALE
and REFUND
transactions (transactionType).",
"$ref": "#/components/schemas/Amount"
},
"feeJurisdiction": {
"description": "This container stores information about region-specific fees that are charged to sellers.INCOME_TAX_WITHHOLDING
TAX_DEDUCTION_AT_SOURCE
VAT_WITHHOLDING
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. 0.0
(no fees deducted from seller payout).",
"$ref": "#/components/schemas/Amount"
},
"totalFeeBasisAmount": {
"description": "This amount is the total amount for the order before selling fees are deducted from the seller payout associated with the order.",
"$ref": "#/components/schemas/Amount"
},
"transactionDate": {
"type": "string",
"description": "This timestamp indicates when the monetary transaction (order purchase, buyer refund, seller credit) occurred. The following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ
. For example, 2015-08-04T19:09:02.768Z
."
},
"transactionId": {
"type": "string",
"description": "The unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller's account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute."
},
"transactionMemo": {
"type": "string",
"description": "This field provides more details on shipping label transactions and transactions where the funds are being held by eBay. For shipping label transactions, the transactionMemo gives details about a purchase, a refund, or a price adjustment to the cost of the shipping label. For on-hold transactions, the transactionMemo provides information on the reason for the hold or when the hold will be released (e.g., \"Funds on hold. Estimated release on Jun 1\").TransactionStatusEnum
type for more information on the different states. For implementation help, refer to eBay API documentation"
},
"transactionType": {
"type": "string",
"description": "This enumeration value indicates the type of monetary transaction. Examples of monetary transactions include a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account. For a complete list of monetary transaction types within the Finances API, see the TransactionTypeEnum type. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used to express the details of one of the following monetary transactions: a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account."
},
"TransactionSummaryResponse": {
"type": "object",
"properties": {
"adjustmentAmount": {
"description": "Total adjustment amount for given payee within a specified period.",
"$ref": "#/components/schemas/Amount"
},
"adjustmentBookingEntry": {
"type": "string",
"description": "The credit debit sign indicator for adjustment. For implementation help, refer to eBay API documentation"
},
"adjustmentCount": {
"type": "integer",
"description": "Total adjustment count for given payee within a specified period.",
"format": "int32"
},
"balanceTransferAmount": {
"description": "The total balance transfer amount for given payee within the specified period.",
"$ref": "#/components/schemas/Amount"
},
"balanceTransferBookingEntry": {
"type": "string",
"description": "The credit debit sign indicator for the balance transfer. For implementation help, refer to eBay API documentation"
},
"balanceTransferCount": {
"type": "integer",
"description": "The total balance transfer count for given payee within the specified period.",
"format": "int32"
},
"creditAmount": {
"description": "This amount is the total dollar value of all the seller's sales and/or credits that match the input criteria. 0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"creditBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the creditAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be CREDIT
. For implementation help, refer to eBay API documentation"
},
"creditCount": {
"type": "integer",
"description": "This integer value indicates the total number of the seller's sales and/or credits that match the input criteria. 0
, but it will not be returned if a transactionType filter is used, and its value is set to either REFUND
, DISPUTE
, or SHIPPING_LABEL
.",
"format": "int32"
},
"disputeAmount": {
"description": "This amount is the total dollar value associated with any existing payment disputes that have been initiated by one or more buyers. Only the orders that match the input criteria are considered. The Payment Disputes methods in the Fulfillment API can be used by the seller to retrieve more information about any payment disputes.0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"disputeBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the disputeAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be DEBIT
, but its possible that CREDIT
could be returned if the seller contested one or more payment disputes and won the dispute. For implementation help, refer to eBay API documentation"
},
"disputeCount": {
"type": "integer",
"description": "This integer value indicates the total number of payment disputes that have been initiated by one or more buyers. Only the orders that match the input criteria are considered. The Payment Disputes methods in the Fulfillment API can be used by the seller to retrieve more information about any payment disputes. 0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than DISPUTE
.",
"format": "int32"
},
"loanRepaymentAmount": {
"description": "The sum of all LOAN_REPAYMENT
transactions (i.e., debit and credit,) that match the input criteria.transactionDate
range, three LOAN_REPAYMENT
transactions are identified:loanRepaymentAmount
will be 20.00 USD.loanRepaymentCount
will be 3loanRepaymentBookingEntry
will be DEBITloanRepaymentCount
=0,) this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"loanRepaymentBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the loanRepaymentAmount
is a DEBIT
against, or a CREDIT
to, the sellers's account.loanRepaymentAmount
transactions, loanRepaymentBookingEntry
will be DEBIT. However, if a loan repayment transaction is reversed, that transaction will be shown as a CREDIT. For implementation help, refer to eBay API documentation"
},
"loanRepaymentCount": {
"type": "integer",
"description": "This integer value indicates the total number of LOAN_REPAYMENT
transactions (i.e., DEBIT
and CREDIT
,) that match the input criteria.transactionType
filter is used and its value has been set to any enumeration value other than LOAN_REPAYMENT
.",
"format": "int32"
},
"nonSaleChargeAmount": {
"description": "The total non-sale charge amount for given payee within a specified period.",
"$ref": "#/components/schemas/Amount"
},
"nonSaleChargeBookingEntry": {
"type": "string",
"description": "The credit/debit sign indicator for the non-sale charge. For implementation help, refer to eBay API documentation"
},
"nonSaleChargeCount": {
"type": "integer",
"description": "The total non-sale charge count for given payee within a specified period.",
"format": "int32"
},
"onHoldAmount": {
"description": "This amount is the total dollar value of order sales where the associated funds are on hold. Only the orders that match the input criteria are considered.0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"onHoldBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the onHoldAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be CREDIT
, since on-hold funds should eventually be released as part of a payout to the seller once the hold is cleared. For implementation help, refer to eBay API documentation"
},
"onHoldCount": {
"type": "integer",
"description": "This integer value indicates the total number of order sales where the associated funds are on hold. Only the orders that match the input criteria are considered.0
, but it will not be returned if a transactionStatus filter is used, and its value is set to any value other than FUNDS_ON_HOLD
.",
"format": "int32"
},
"purchaseAmount": {
"description": "Note: The PURCHASE
transaction type is currently only applicable in the US marketplace.purchaseCount=0
), this container will not be returned.",
"$ref": "#/components/schemas/Amount"
},
"purchaseBookingEntry": {
"type": "string",
"description": "Note: The PURCHASE
transaction type is currently only applicable in the US marketplace.PURCHASE
transaction type is currently only applicable in the US marketplace.0
. However, it will not be returned if a transactionType
filter is used and its value has been set to any enumeration value other than PURCHASE
.",
"format": "int32"
},
"refundAmount": {
"description": "This amount is the total dollar value of buyer refunds that match the input criteria.0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"refundBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the refundAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be DEBIT
since this a refund from the seller to the buyer. For implementation help, refer to eBay API documentation"
},
"refundCount": {
"type": "integer",
"description": "This integer value indicates the total number of buyer refunds that match the input criteria. 0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than REFUND
.",
"format": "int32"
},
"shippingLabelAmount": {
"description": "This is the total dollar value of the eBay shipping labels purchased by the seller.",
"$ref": "#/components/schemas/Amount"
},
"shippingLabelBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the shippingLabelAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be DEBIT
, as eBay will charge the seller when eBay shipping labels are purchased, but it can be CREDIT
if the seller was refunded for a shipping label or was possibly overcharged for a shipping label. For implementation help, refer to eBay API documentation"
},
"shippingLabelCount": {
"type": "integer",
"description": "This is the total number of eBay shipping labels purchased by the seller. The count returned here may depend on the specified input criteria.",
"format": "int32"
},
"transferAmount": {
"description": "This amount is the total dollar value of buyer refund transfers that match the input criteria.0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"transferBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the transferAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be DEBIT
since this a seller reimbursement to eBay for buyer refunds. For implementation help, refer to eBay API documentation"
},
"transferCount": {
"type": "integer",
"description": "This integer value indicates the total number of buyer refund transfers that match the input criteria. 0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than TRANSFER
.",
"format": "int32"
},
"withdrawalAmount": {
"description": "This amount is the total dollar value of on-demand payouts (withdrawals) that match the input criteria.0
), this container is not returned.",
"$ref": "#/components/schemas/Amount"
},
"withdrawalBookingEntry": {
"type": "string",
"description": "The enumeration value indicates whether the dollar amount in the withdrawalAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be DEBIT
since this transaction involves a debit to the seller's available payout funds. For implementation help, refer to eBay API documentation"
},
"withdrawalCount": {
"type": "integer",
"description": "This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria. 0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than WITHDRAWAL
.",
"format": "int32"
}
},
"description": "This type is the base response type of the getTransactionSummary method, and based on the filters that are used in the getTransactionSummary call URI, the response may include total count and amount of the seller's sales and credits, total count and amount of buyer refunds, and total count and amount of seller payment holds."
},
"Transactions": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URI of the getTransactions method request that produced the current page of the result set."
},
"limit": {
"type": "integer",
"description": "The maximum number of monetary transactions that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20
. 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": "int32"
},
"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": "int32"
},
"prev": {
"type": "string",
"description": "The getTransactions method URI to use if you wish to view the previous page of the result set. YYYY-MM-DDTHH:MM:SS.SSSZ
. For example, 2020-08-04T19:09:02.768Z
"
},
"transferAmount": {
"description": "The amount of the transfer being deducted from the funding source.",
"$ref": "#/components/schemas/Amount"
},
"transferDetail": {
"description": "This container provides more details about the transfer, including details on the charge(s) associated with the transfer. Multiple charges can be addressed with one transfer.",
"$ref": "#/components/schemas/TransferDetail"
},
"transferId": {
"type": "string",
"description": "The unique identifier of the TRANSFER
transaction type. This is the same value that was passed into the end of the call URI."
}
},
"description": "This type is the base response type used by TRANSFER
transaction type that is returned in the response."
},
"TransferDetail": {
"type": "object",
"properties": {
"balanceAdjustment": {
"description": "This container shows the seller payout balance that will be applied toward the charges outlined in the charges array.",
"$ref": "#/components/schemas/BalanceAdjustment"
},
"charges": {
"type": "array",
"description": "This container is an array of one or more charges related to the transfer. Charges can be related to an order cancellation, order return, case, payment dispute, etc.",
"items": {
"$ref": "#/components/schemas/Charge"
}
},
"totalChargeNetAmount": {
"description": "This container shows the total amount that the seller owes for all of the charges outlined in the charges array.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type is used by the transferDetail container, which provides more details about the transfer and the charge(s) associated with the transfer."
}
},
"securitySchemes": {
"api_auth": {
"type": "oauth2",
"description": "The security definitions for this API. Please check individual operations for applicable scopes.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/sell.finances": "View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application"
}
}
}
}
}
}
}