Skip to main content

GET/transaction_summary

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 getTransactionSummary method retrieves cumulative information for monetary transactions. If applicable, the number of payments with a transactionStatus equal to FUNDS_ON_HOLD and the total monetary amount of these on-hold payments are also returned.

Note: For a complete list of transaction types, refer to TransactionTypeEnum.
Refer to the filter field for additional information about each filter and its use.

Note: Unless a transactionType filter is used to retrieve a specific type of transaction (e.g., SALE, REFUND, etc.,) the creditCount and creditAmount response fields both include order sales and seller credits information. That is, the count and value fields do not distinguish between these two types monetary transactions.

Input

Resource URI

GET https://apiz.ebay.com/sell/finances/v1/transaction_summary?

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
filterarray of FilterFieldNumerous filters are available for the getTransactionSummary method, and these filters are discussed below. One or more of these filter types can be used. The transactionStatus filter must be used. All other filters are optional.
  • transactionStatus: the data returned in the response pertains to the sales, payouts, and transfer status set. For supported transactionStatus values, see TransactionStatusEnum.

    Below is the proper syntax to use when setting up the transactionStatus filter:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}
  • transactionDate: only consider monetary transactions that occurred within a specific range of dates.

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

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

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[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: only consider a specific type of monetary transaction. For supported transactionType values, see TransactionTypeEnum.

    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}
  • buyerUsername: only consider monetary transactions involving a specific buyer (specified with the buyer's eBay user ID). Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}
  • salesRecordReference: only consider monetary transactions corresponding to a specific order (identified with a Selling Manager order identifier). 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_summary?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: only consider monetary transactions related to a specific seller payout (identified with a Payout ID). This value is auto-generated by eBay once the seller payout is set to be processed. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction(s) associated with this transactionId value are returned.

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

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

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. For any other monetary transaction, the transactionId filter should be used instead. Only the monetary transaction(s) associated with this orderId value are returned. Below is the proper syntax to use if filtering by a specific order ID:

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

Occurrence: Required

HTTP request headers

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

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.

See HTTP request headers for the marketplace ID values.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.

Occurrence: Required

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

{ /* TransactionSummaryResponse */ }

Response fields

Output container/fieldTypeDescription
adjustmentAmountAmount

Total adjustment amount for given payee within a specified period.

Occurrence: Conditional

adjustmentAmount.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

adjustmentAmount.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

adjustmentAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

adjustmentAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

adjustmentAmount.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

adjustmentAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

adjustmentAmount.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

adjustmentBookingEntryBookingEntryEnum

The credit debit sign indicator for adjustment.

Occurrence: Conditional

adjustmentCountinteger

Total adjustment count for given payee within a specified period.

Occurrence: Conditional

balanceTransferAmountAmount

The total balance transfer amount for given payee within the specified period.

Occurrence: Conditional

balanceTransferAmount.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

balanceTransferAmount.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

balanceTransferAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

balanceTransferAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

balanceTransferAmount.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

balanceTransferAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

balanceTransferAmount.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

balanceTransferBookingEntryBookingEntryEnum

The credit debit sign indicator for the balance transfer.

Occurrence: Conditional

balanceTransferCountinteger

The total balance transfer count for given payee within the specified period.

Occurrence: Conditional

creditAmountAmount

This amount is the total dollar value of all the seller's sales and/or credits that match the input criteria.

Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction, the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).

If there are no sales/credits (creditCount=0), this container is not returned.

Occurrence: Conditional

creditAmount.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

creditAmount.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

creditAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

creditAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

creditAmount.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

creditAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

creditAmount.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

creditBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

creditCountinteger

This integer value indicates the total number of the seller's sales and/or credits that match the input criteria.

Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction (sale, buyer refund, or seller credit), the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).

This field is generally returned, even if 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.

Occurrence: Conditional

disputeAmountAmount

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.

If there are no payment disputes (disputeCount=0), this container is not returned.

Occurrence: Conditional

disputeAmount.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

disputeAmount.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

disputeAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

disputeAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

disputeAmount.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

disputeAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

disputeAmount.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

disputeBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

disputeCountinteger

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.

This field is generally returned, even if 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than DISPUTE.

Occurrence: Conditional

loanRepaymentAmountAmount

The sum of all LOAN_REPAYMENT transactions (i.e., debit and credit,) that match the input criteria.

For example, within a specified transactionDate range, three LOAN_REPAYMENT transactions are identified:

  • DEBIT of 15.00 USD
  • DEBIT of 10.00 USD
  • CREDIT of 5.00 USD

The net amount of these three transactions is a DEBIT of 20.00 USD to the seller's account. Therefore, the value returned for loanRepaymentAmount will be 20.00 USD.

Note: For this example:
  • The value returned for loanRepaymentCount will be 3
  • The loanRepaymentBookingEntry will be DEBIT

If there are no transactions that match the input criteria (i.e., loanRepaymentCount=0,) this container is not returned.

Occurrence: Conditional

loanRepaymentAmount.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

loanRepaymentAmount.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

loanRepaymentAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

loanRepaymentAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

loanRepaymentAmount.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

loanRepaymentAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

loanRepaymentAmount.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

loanRepaymentBookingEntryBookingEntryEnum

The enumeration value indicates whether the loanRepaymentAmount is a DEBIT against, or a CREDIT to, the sellers's account.

For most loanRepaymentAmount transactions, loanRepaymentBookingEntry will be DEBIT. However, if a loan repayment transaction is reversed, that transaction will be shown as a CREDIT.

Occurrence: Conditional

loanRepaymentCountinteger

This integer value indicates the total number of LOAN_REPAYMENT transactions (i.e., DEBIT and CREDIT,) that match the input criteria.

This field is generally returned even if it equals 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 LOAN_REPAYMENT.

Occurrence: Conditional

nonSaleChargeAmountAmount

The total non-sale charge amount for given payee within a specified period.

Occurrence: Conditional

nonSaleChargeAmount.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

nonSaleChargeAmount.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

nonSaleChargeAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

nonSaleChargeAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

nonSaleChargeAmount.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

nonSaleChargeAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

nonSaleChargeAmount.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

nonSaleChargeBookingEntryBookingEntryEnum

The credit/debit sign indicator for the non-sale charge.

Occurrence: Conditional

nonSaleChargeCountinteger

The total non-sale charge count for given payee within a specified period.

Occurrence: Conditional

onHoldAmountAmount

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.

If there are no seller payment holds (onHoldCount=0), this container is not returned.

Occurrence: Conditional

onHoldAmount.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

onHoldAmount.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

onHoldAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

onHoldAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

onHoldAmount.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

onHoldAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

onHoldAmount.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

onHoldBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

onHoldCountinteger

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.

This field is generally returned, even if 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.

Occurrence: Conditional

purchaseAmountAmount

Note: The PURCHASE transaction type is currently only applicable in the US marketplace.
This amount is the total dollar value of all the purchases that have been initiated by a seller using spendable funds that match the input criteria.

If there are no transactions that match the input criteria (i.e., purchaseCount=0), this container will not be returned.

Occurrence: Conditional

purchaseAmount.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

purchaseAmount.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

purchaseAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

purchaseAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

purchaseAmount.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

purchaseAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

purchaseAmount.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

purchaseBookingEntryBookingEntryEnum

Note: The PURCHASE transaction type is currently only applicable in the US marketplace.
This enumeration value indicates whether the dollar amount in the purchase field is a charge (debit) to the seller or a credit.

Occurrence: Conditional

purchaseCountinteger

Note: The PURCHASE transaction type is currently only applicable in the US marketplace.
This integer value indicates the total number of purchases that have been initiated by a seller using spendable funds that match the input criteria.

This field is generally returned, even if it equals 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.

Occurrence: Conditional

refundAmountAmount

This amount is the total dollar value of buyer refunds that match the input criteria.

If there are no refunds (refundCount=0), this container is not returned.

Occurrence: Conditional

refundAmount.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

refundAmount.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

refundAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

refundAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

refundAmount.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

refundAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

refundAmount.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

refundBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

refundCountinteger

This integer value indicates the total number of buyer refunds that match the input criteria.

This field is generally returned, even if 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than REFUND.

Occurrence: Conditional

shippingLabelAmountAmount

This is the total dollar value of the eBay shipping labels purchased by the seller.

Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the amounts returned in this container.

Occurrence: Conditional

shippingLabelAmount.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

shippingLabelAmount.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

shippingLabelAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

shippingLabelAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

shippingLabelAmount.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

shippingLabelAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

shippingLabelAmount.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

shippingLabelBookingEntryBookingEntryEnum

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.

Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in this field.

Occurrence: Conditional

shippingLabelCountinteger

This is the total number of eBay shipping labels purchased by the seller. The count returned here may depend on the specified input criteria.

Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the count returned in this container.

Occurrence: Conditional

transferAmountAmount

This amount is the total dollar value of buyer refund transfers that match the input criteria.

If there are no transfers (refundCount=0), this container is not returned.

Occurrence: Conditional

transferAmount.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

transferAmount.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

transferAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

transferAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

transferAmount.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

transferAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

transferAmount.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

transferBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

transferCountinteger

This integer value indicates the total number of buyer refund transfers that match the input criteria.

This field is generally returned, even if 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than TRANSFER.

Occurrence: Conditional

withdrawalAmountAmount

This amount is the total dollar value of on-demand payouts (withdrawals) that match the input criteria.

If there are no withdrawals (withdrawalCount=0), this container is not returned.

Occurrence: Conditional

withdrawalAmount.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

withdrawalAmount.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

withdrawalAmount.convertedToCurrencyCurrencyCodeEnum

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY.The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field.

This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

withdrawalAmount.convertedToValuestring

Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.

The field is only returned for payouts to bank accounts when currency conversion was applied by eBay.

Occurrence: Conditional

withdrawalAmount.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

withdrawalAmount.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.

For sellers in mainland China, this field shows shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue 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

withdrawalAmount.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

withdrawalBookingEntryBookingEntryEnum

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.

Occurrence: Conditional

withdrawalCountinteger

This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria.

This field is generally returned, even if 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than WITHDRAWAL.

Occurrence: Conditional

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
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.
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.
135011API_FINANCESREQUESTTransaction status filter is mandatory.

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 Counts and Values for Paid Out Monetary Transactions

This call sample retrieves a summary of all transaction types for sales orders that have been paid out to the seller. The transaction status filter is set to 'PAYOUT'.

Input

The transactionStatus filter is required and set to PAYOUT.

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

?filter=filter_type:{filter_value}

GEThttps://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}

Output

The output shows the total count and cumulative dollar values of seller payouts/credits and purchased eBay shipping labels. In the getTransactionSummary response, there is no distinction between seller proceeds from orders and seller credits issued by eBay. There were a total of two credits for a cumulative amount of $217.60, and one purchased shipping label for an amount of $9.22. Notice that there are no buyer refunds, buyer-initiated disputes, loan repayments, withdraws, seller purchases, or seller payments on hold, so these counts are shown as 0, but their corresponding 'amount' and 'booking entry' fields are not shown since they are not applicable.

Sample 2: Get Seller Credit Counts and Values for Paid Out Monetary Transactions

This call sample retrieves the total seller credit count and cumulative dollar values for these credits associated with all sales transactions that have been paid out. The transaction status filter is set to 'PAYOUT' and the transaction type filter is set to 'CREDIT'.

Input

The transactionStatus filter is required and set to PAYOUT, and transactionType filter is included and set to CREDIT.

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

?filter=filter_type:{filter_value}

GEThttps://apiz.ebay.com/sell/finances/v1_alpha/transaction_summary?filter=transactionStatus:{PAYOUT}&filter=transactionType:{CREDIT}

Output

The output shows the total count and cumulative dollar values of seller credits. Since transactionType filter was included and set to CREDIT, the creditCount and creditAmount values are only from seller credits (and none are from seller payouts).

Sample 3: Get Counts and Values for Transfers

This call sample retrieves the counts and cumulative dollar values for these credits associated with all transfer transactions that have been paid out. The transaction type filter is set to 'TRANSFER'.

Input

The transactionType filter is included and set to TRANSFER.

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

?filter=filter_type:{filter_value}

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

Output

The output shows the total count and cumulative dollar values of monetary transfers.