Skip to main content

GET/transaction

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.


The getTransactions method allows a seller to retrieve information about one or more of their monetary transactions.

Note: For a complete list of transaction types, refer to TransactionTypeEnum.
Numerous input filters are available which can be used individualy or combined to refine the data that are returned. For example:
  • SALE transactions for August 15, 2022;
  • RETURN transactions for the month of January, 2021;
  • Transactions currently in a transactionStatus equal to FUNDS_ON_HOLD.
Refer to the filter field for additional information about each filter and its use.

Pagination and sort query parameters are also provided that allow users to further control how monetary transactions are displayed in the response.

If no monetary transactions match the input criteria, an http status code of 204 No Content is returned with no response payload.

Input

Resource URI

GET https://apiz.ebay.com/sell/finances/v1/transaction?
limit=integer&
offset=integer&
filter=FilterField&
sort=SortField&

This method is supported in Sandbox environment. To access the endpoint, just replace the apiz.ebay.com root URI with apiz.sandbox.ebay.com

URI parameters

ParameterTypeDescription
limitintegerThe number of monetary transactions to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the method retrieves monetary transactions 11 thru 20 from the result set.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

Maximum: 1000
Default: 20

Occurrence: Optional

offsetintegerThis integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the method retrieves transactions 31 thru 40 from the resulting collection of transactions.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
Default: 0 (zero)

Occurrence: Optional

filterarray of FilterFieldNumerous filters are available for the getTransactions method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all monetary transactions from the last 90 days are returned:
  • transactionDate: search for monetary transactions that occurred within a specific range of dates.

    Note: All dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.

    Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • transactionType: search for a specific type of monetary transaction. The supported transactionType values are as follows:
    • SALE: a sales order.
    • REFUND: a refund to the buyer after an order cancellation or return.
    • CREDIT: a credit issued by eBay to the seller's account.
    • DISPUTE: a monetary transaction associated with a payment dispute between buyer and seller.
    • NON_SALE_CHARGE: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.
    • SHIPPING_LABEL: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
    • TRANSFER: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
    • ADJUSTMENT: An adjustment is a monetary transaction where eBay is crediting or debiting the seller's account.
    • WITHDRAWAL: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay.

      Note: On-demand payout is not available for sellers who are already on a daily payout schedule. In order to initiate an on-demand payout, a seller must be on a weekly, bi-weekly, or monthly payout schedule.
    • LOAN_REPAYMENT: A monetary transaction related to the repayment of an outstanding loan balance for approved participants enrolled in the eBay Seller Capital financing program.

      Note: eBay Seller Capital financing is only available in select marketplaces. Refer to Marketplace availability for eBay Seller Capital funding program for current marketplace eligibility.
    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}
  • transactionStatus: this filter type is only applicable for sales orders, and allows the user to filter seller payouts in a particular state. The supported transactionStatus values are as follows:
    • PAYOUT: this indicates that the proceeds from the corresponding sales order has been paid out to the seller's account.
    • FUNDS_PROCESSING: this indicates that the funds for the corresponding monetary transaction are currently being processed.
    • FUNDS_AVAILABLE_FOR_PAYOUT: this indicates that the proceeds from the corresponding sales order are available for a seller payout, but processing has not yet begun.
    • FUNDS_ON_HOLD: this indicates that the proceeds from the corresponding sales order are currently being held by eBay, and are not yet available for a seller payout.
    • COMPLETED: this indicates that the funds for the corresponding TRANSFER monetary transaction have transferred and the transaction has completed.
    • FAILED: this indicates the process has failed for the corresponding TRANSFER monetary transaction.
    Below is the proper syntax to use if filtering by transaction status:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}
  • buyerUsername: the eBay user ID of the buyer involved in the monetary transaction. Only monetary transactions involving this buyer are returned. Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}
  • salesRecordReference: the unique Selling Manager identifier of the order involved in the monetary transaction. Only monetary transactions involving this Selling Manager Sales Record ID are returned. Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=salesRecordReference:{123}

    Note: For all orders originating after February 1, 2020, a value of 0 will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date.
  • payoutId: the unique identifier of a seller payout. This value is auto-generated by eBay once the seller payout is set to be processed. Only monetary transactions involving this Payout ID are returned. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction defined by the identifier is returned.

    Note: This filter cannot be used alone; the transactionType must also be specified when filtering by transaction ID.

    Below is the proper syntax to use if filtering by a specific transaction ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. Only monetary transaction(s) associated with this orderId value are returned.

    For any other monetary transaction, the transactionId filter should be used instead.

    Below is the proper syntax to use if filtering by a specific order ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3}

Occurrence: Optional

sortarray of SortFieldSorting is not yet available for the getTransactions method. By default, monetary transactions that match the input criteria are sorted in descending order according to the transaction date.

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This call conditionally requires the Accept:application/json and the X-EBAY-C-MARKETPLACE-ID headers.

The Accept header indicates the formats the client accepts for the response. This header pairs with the Content-Type header, which specifies the format required by eBay for the request. Currently, all eBay REST interfaces require request bodies to be formatted in JSON, and JSON is the default and only format returned in response bodies.

The X-EBAY-C-MARKETPLACE-ID header identifies the user's business context. See https://developer.ebay.com/managed-payments for supported marketplaces. If not included with your request, the marketplace value defaults to EBAY-US. Note that it does not indicate a language preference or end-user location.

Example:
X-EBAY-C-MARKETPLACE-ID: EBAY-US
Accept:application/json

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values.

Occurrence: Conditional

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.finances

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* Transactions */
"href" : "string",
"limit" : "integer",
"next" : "string",
"offset" : "integer",
"prev" : "string",
"total" : "integer",
"transactions" : [
{ /* Transaction */
"amount" :
{ /* Amount */
"convertedFromCurrency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"convertedFromValue" : "string",
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"exchangeRate" : "string",
"value" : "string"
},
"bookingEntry" : "BookingEntryEnum : [CREDIT,DEBIT]",
"buyer" :
{ /* Buyer */
"username" : "string"
},
"eBayCollectedTaxAmount" :
{ /* Amount */
"convertedFromCurrency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"convertedFromValue" : "string",
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"exchangeRate" : "string",
"value" : "string"
},
"feeJurisdiction" :
{ /* FeeJurisdiction */
"regionName" : "string",
"regionType" : "RegionTypeEnum : [COUNTRY,STATE_OR_PROVINCE]"
},
"feeType" : "FeeTypeEnum : [AD_FEE,AUCTION_END_EARLY_FEE,BELOW_STANDARD_FEE...]",
"orderId" : "string",
"orderLineItems" : [
{ /* OrderLineItem */
"feeBasisAmount" :
{ /* Amount */
"convertedFromCurrency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"convertedFromValue" : "string",
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"exchangeRate" : "string",
"value" : "string"
},
"lineItemId" : "string",
"marketplaceFees" : [
{ /* Fee */
"amount" :
{ /* Amount */
"convertedFromCurrency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"convertedFromValue" : "string",
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"exchangeRate" : "string",
"value" : "string"
},
"feeJurisdiction" :
{ /* FeeJurisdiction */
"regionName" : "string",
"regionType" : "RegionTypeEnum : [COUNTRY,STATE_OR_PROVINCE]"
},
"feeMemo" : "string",
"feeType" : "FeeTypeEnum : [AD_FEE,AUCTION_END_EARLY_FEE,BELOW_STANDARD_FEE...]"
}
]
}
],
"paymentsEntity" : "string",
"payoutId" : "string",
"references" : [
{ /* Reference */
"referenceId" : "string",
"referenceType" : "ReferenceTypeEnum : [CANCELLATION_ID,CASE_ID,INVOICE...]"
}
],
"salesRecordReference" : "string",
"totalFeeAmount" : "Amount",
"totalFeeBasisAmount" : "Amount",
"transactionDate" : "string",
"transactionId" : "string",
"transactionMemo" : "string",
"transactionStatus" : "TransactionStatusEnum : [FUNDS_ON_HOLD,FUNDS_PROCESSING,FUNDS_AVAILABLE_FOR_PAYOUT...]",
"transactionType" : "TransactionTypeEnum : [SALE,REFUND,CREDIT...]"
}
]
}

Response fields

Output container/fieldTypeDescription
hrefstring

The URI of the getTransactions method request that produced the current page of the result set.

Occurrence: Always

limitinteger

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.

Note: If this is the last or only page of the result set, the page may contain fewer monetary transactions than the limit value. To determine the number of pages in a result set, divide the total value (total number of monetary transactions matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 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.

Maximum: 200
Default: 20

Occurrence: Always

nextstring

The getTransactions method URI to use if you wish to view the next page of the result set.

This field is only returned if there is a next page of results to view based on the current input criteria.

Occurrence: Conditional

offsetinteger

This integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the method retrieves monetary transactions 31 thru 40 from the resulting collection of monetary transactions.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

Default: 0 (zero)

Occurrence: Always

prevstring

The getTransactions method URI to use if you wish to view the previous page of the result set.

This field is only returned if there is a previous page of results to view based on the current input criteria.

Occurrence: Conditional

totalinteger

This integer value is the total amount of monetary transactions in the result set based on the current input criteria. Based on the total number of monetary transactions that match the criteria, and on the limit and offset values, there may be additional pages in the results set.

Occurrence: Always

transactionsarray of Transaction

An array of one or more monetary transactions that match the input criteria. Details for each monetary transaction may include the unique identifier of the order associated with the monetary transaction, the status of the transaction, the amount of the order, the order's buyer, and the unique identifier of the payout (if a payout has been initiated/issued for the order).

Occurrence: Always

transactions.amountAmount

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.

Occurrence: Always

transactions.amount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.amount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.amount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

transactions.amount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.amount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

transactions.bookingEntryBookingEntryEnum

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.

Occurrence: Always

transactions.buyerBuyer

This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER monetary transaction types.

Occurrence: Conditional

transactions.buyer.usernamestring

The eBay user ID of the order's buyer.

Occurrence: Always

transactions.eBayCollectedTaxAmountAmount

This is the amount of sales tax that has been collected by eBay for an order.

Note: Sales tax applies only to SALE and REFUND transactions (transactionType).

Occurrence: Conditional

transactions.eBayCollectedTaxAmount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.eBayCollectedTaxAmount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.eBayCollectedTaxAmount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

transactions.eBayCollectedTaxAmount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.eBayCollectedTaxAmount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

transactions.feeJurisdictionFeeJurisdiction

This container stores information about region-specific fees that are charged to sellers.

This is returned for fees (i.e., FeeTypeEnum values,) that are mandated by a seller's governing jurisdiction.

For example:

  • INCOME_TAX_WITHHOLDING
  • TAX_DEDUCTION_AT_SOURCE
  • VAT_WITHHOLDING

Occurrence: Conditional

transactions.feeJurisdiction.regionNamestring

String value that indicates the name of the region to which a region-specific fee applies.

The set of valid regionName values that may be returned is determined by the regionType value.

Note: Currently, supported regionName values that may be returned are standard two-character country or state codes.

Typical examples include:

  • MX [Mexico]
  • IN [India]
  • US [United States]
  • CA [California]
  • VT [Vermont]
  • ME [Maine]

Occurrence: Conditional

transactions.feeJurisdiction.regionTypeRegionTypeEnum

The enumeration value returned here indicates the type of region that is collecting the corresponding fee.

Occurrence: Conditional

transactions.feeTypeFeeTypeEnum

The type of fee.

Occurrence: Conditional

transactions.orderIdstring

The unique identifier of the eBay order associated with the monetary transaction.

Occurrence: Conditional

transactions.orderLineItemsarray of OrderLineItem

This array shows the fees that are deducted from a seller payout for each line item in an order.

Note: In some cases, a transaction fee might be returned asynchronously from the associated order. In such cases, you can determine the order to which the fee applies by examining the referenceID value of the fee, which should match the ID of the order.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmountAmount

This is the total amount of fees accrued for the order line item and deducted from a seller payout. All of the fees under the marketplaceFees container should equal this amount.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.feeBasisAmount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

transactions.orderLineItems.lineItemIdstring

The unique identifier of an order line item.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFeesarray of Fee

An array of all fees accrued for the order line item and deducted from a seller payout.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amountAmount

The amount of the fee.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amount.convertedFromCurrencyCurrencyCodeEnum

The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amount.convertedFromValuestring

The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amount.currencyCurrencyCodeEnum

A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amount.exchangeRatestring

The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned when eBay does a currency version, and a currency conversion is generally needed if the buyer is viewing, or has purchased an item on an international site.

This field is only returned if/when currency conversion was applied by eBay.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.amount.valuestring

The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.feeJurisdictionFeeJurisdiction

Indicates the specific jurisdiction for the fee that has been deducted from the seller payour.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.feeJurisdiction.regionNamestring

String value that indicates the name of the region to which a region-specific fee applies.

The set of valid regionName values that may be returned is determined by the regionType value.

Note: Currently, supported regionName values that may be returned are standard two-character country or state codes.

Typical examples include:

  • MX [Mexico]
  • IN [India]
  • US [United States]
  • CA [California]
  • VT [Vermont]
  • ME [Maine]

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.feeJurisdiction.regionTypeRegionTypeEnum

The enumeration value returned here indicates the type of region that is collecting the corresponding fee.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.feeMemostring

A description of the fee that was deducted from the seller payout.

Occurrence: Conditional

transactions.orderLineItems.marketplaceFees.feeTypeFeeTypeEnum

The enumeration value returned here indicates the type of fee that was deducted from the seller payout.

Occurrence: Conditional

transactions.paymentsEntitystring

This string value indicates the entity that is processing the payment.

Occurrence: Conditional

transactions.payoutIdstring

The unique identifier of the seller payout associated with the monetary transaction. This identifier is generated once eBay begins processing the payout for the corresponding order. This field will not be returned if eBay has not yet begun processing the payout for an order.

Occurrence: Conditional

transactions.referencesarray of Reference

This field contains reference information for the transaction fee. This includes an ID and the type of ID provided (such as item ID).

Occurrence: Conditional

transactions.references.referenceIdstring

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.

Occurrence: Conditional

transactions.references.referenceTypeReferenceTypeEnum

An enumeration value that identifies the reference type associated with the referenceId.

Occurrence: Conditional

transactions.salesRecordReferencestring

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.

Note: For all orders originating after February 1, 2020, a value of 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.

Occurrence: Always

transactions.totalFeeAmountAmount

This amount is the total amount of selling fees paid for order. A breakdown of fees for each order line item can be found in the orderLineItems array.

This field is even returned if it is 0.0 (no fees deducted from seller payout).

Occurrence: Conditional

transactions.totalFeeBasisAmountAmount

This amount is the total amount of the order before selling fees are deducted from the seller payout associated with the order. To determine the actual amount of the order that will be paid out through a seller payout, deduct the totalFeeAmount from the basePayoutAmount.

Occurrence: Conditional

transactions.transactionDatestring

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.

Occurrence: Always

transactions.transactionIdstring

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.

Occurrence: Always

transactions.transactionMemostring

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").

This field is only returned if applicable/available.

Occurrence: Conditional

transactions.transactionStatusTransactionStatusEnum

This enumeration value indicates the current status of the seller payout associated with the monetary transaction. See the TransactionStatusEnum type for more information on the different states.

Occurrence: Always

transactions.transactionTypeTransactionTypeEnum

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.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
204No Content
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
135000API_FINANCESAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
135003API_FINANCESREQUESTThe value of pagination is invalid.
135005API_FINANCESREQUESTThe value of sorting is invalid.
135006API_FINANCESREQUESTThe value of transaction type filter is invalid.
135007API_FINANCESREQUESTThe value of transaction status filter is invalid.
135008API_FINANCESREQUESTThe value of transaction date filter is invalid.
135009API_FINANCESREQUESTTransaction type filter is missing.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get All Transactions

This call sample retrieves all recent monetary transactions. No filters, no sorting, and no pagination parameters are used.

Input

Only the GET HTTP method and the endpoint are used. No filter parameters, no sorting, and no pagination query parameters are used.

GEThttps://apiz.ebay.com/sell/finances/v1/transaction

Output

The output returns details on 20 recent monetary transactions. Unless a sort query parameter is used, monetary transactions in a getTransactions response are sorted according to sale date in descending order (most recent sale first). Since no pagination query parameters were used, the limit value defaults to 20 (up to 20 payouts per page of the result set) and the offset value defaults to 0 (the first payout in the result set is shown first). Since the next field appears in the response, there are actually more than 20 monetary transactions to view, but the current page is only showing 20 since the limit value is 20. The next field contains the full call URI to use to retrieve the next page of the result set.

Each monetary transaction is identified with its transactionId value. This transactionId value is auto-generated by eBay as soon as a buyer purchases an item, or if there is a commitment to buy (e.g., a winning bidder of an auction). The transactionType value will either be SALE, REFUND, CREDIT, or TRANSFER. This particular response does not include any seller credits. If a payout has already been issued for a sale, the transactionStatus value will show PAYOUT, and the payoutId value will identify the payout. If the transactionStatus value shows FUNDS_ON_HOLD or FUNDS_PROCESSING for a sale, you will not see a payoutId field for that sale. If the transactionStatus value shows FUNDS_ON_HOLD, the transactionMemo provides information on the reason for the hold or when the hold will be released.

Sample 2: Get Sales Within a Date Range

This call sample retrieves sales within a date range. Two filter parameters are used and configured to return sales within a stated date range.

Input

For this sample, two filter query parameters are used - one to filter by the transaction type of SALE, and one to filter within a date range. In this sample, the date range is between October 23 and November 9, 2018.

Below is the syntax to use for a non-date filter:

?filter=filter_type:{filter_value}

The syntax to use for a date range filter is slightly different, and is shown below. Notice the date range filter uses square brackets instead of curly brackets.

?filter=payoutDate:[YYYY-MM-DDTHH:MM:SS.SSSZ..YYYY-MM-DDTHH:MM:SS.SSSZ]

GEThttps://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}&filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

Output

The output returns details on 16 sales that occurred within the specified date range. Since no pagination query parameters were used, the limit value defaults to 20 (up to 20 transactions per page of the result set) and the offset value defaults to 0 (the first transaction in the result set is shown first). Since only 16 successful sales transactions are returned, this response is showing all sales that occurred within the date range.

Each sales transaction is identified with its transactionId value. This transactionId value is auto-generated by eBay as soon as a buyer purchases an item, or if there is a commitment to buy (e.g., a winning bidder of an auction). For many of the sales transactions in this response, payouts have already been issued (the transactionStatus value shows PAYOUT, and the payoutId value identifies the payout. For other sales transactions, the transactionStatus value shows FUNDS_ON_HOLD or FUNDS_PROCESSING, which means the payout associated with the sales transaction has yet to occur. If the transactionStatus value shows FUNDS_ON_HOLD, the transactionMemo provides information on the reason for the hold or when the hold will be released.

Sample 3: Get Sales With Payment Holds

This call sample retrieves sales with payment holds. Two filter parameters are used and configured to return sales with payment holds.

Input

For this sample, two filter query parameters are used - one to filter by the transaction type of SALE, and one to filter by the transaction status of FUNDS_ON_HOLD

Below is the syntax to use for a non-date filter:

?filter=filter_type:{filter_value}

GEThttps://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}&filter=transactionStatus:{FUNDS_ON_HOLD}

Output

The output indicates that there are only two sales transactions where payout funds are on hold. The transactionMemo field gives more details on the reason for the hold or when the hold will be released. To get more information on payment holds, including the expected fund release date, the user can call getOrder.

Sample 4: Get Refunds for Specific Buyer

This call sample gets refunds for a specific buyer. Two filter parameters are used and configured to return refunds issued to a specific buyer.

Input

For this sample, two filter query parameters are used: one to filter by the transaction type of REFUND, and one to filter by the buyer's eBay user ID. For this particular call sample, the buyer's eBay user ID is r********2, so all refunds issued to this buyer by the are returned.

Below is the syntax to use for a non-date filter:

?filter=filter_type:{filter_value}

GEThttps://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{REFUND}&filter=buyerUsername:{r********2}

Output

A total of four refunds to the buyer are part of the result set, as indicated by a value of 4 in the total field. The seller has already been paid out for two of the sales transactions where the buyer will receive a refund, but the seller is still waiting for the payouts for the two other sales transactions.

Sample 5: Shipping Label Transactions

This call sample shows shipping label transactions, including a purchase of a shipping label, a refund for a shipping label, and a price adjustment for cost of shipping label.

Input

For this sample, a transactionType filter is used to retrieve only shipping label transactions. The value of the transactionType filter is set to SHIPPING_LABEL.

Below is the syntax to use for a non-date filter:

?filter=filter_type:{filter_value}

GEThttps://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SHIPPING_LABEL}

Output

A total of five shipping label transactions are part of the result set, as indicated by a value of 5 in the total field. The transactionMemo field gives more details on each shipping label transaction, and the bookingEntry field value indicates whether it is charge (debit) or credit to the seller.

Sample 6: Get final value fees for an order

This call sample shows final value fees for a specific order. An orderId value is used as a filter, so only transactions related to that sales order are returned.

Input

For this sample, orderId is include as a filter, and the seller wishes to retrieve all transactions related to the order ID 03-00011-61743.

GEThttps://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0********3}

Output

Only one SALE transaction is returned for the order. The totalFeeBasisAmount is the total amount of the order used to calculate the seller's final value fees for the order. The total amount of seller fees deducted from a seller payout associated with the order is shown in the totalFeeAmount field. Line item-level information about seller fees are returned in the orderLineItems array. This particular order contains just one line item.