Just getting started with the Finances API? See the following documents for details on using this API:

The API release history

The following table lists recent Finances API releases. For older releases, see the Finances API release notes archive.

Release Version Release Date Description of Release
Version 1.11.0 2022-05-05 Added support for reporting the automatic deduction of withholding/income taxes from specified regions.
Version 1.10.0 2022-03-07

A new withdrawal transaction type is now supported in getTransactions and getTransactionSummary methods.

A new enumeration value has been added to the ReferenceTypeEnum for the getTransactions method.

Version 1.9.0 2021-06-24 New bankReference and payoutMemo output fields added to the getPayout and getPayouts methods.
Version 1.8.0 2021-04-07 A new feeMemo field was added to the Fee type for the getTransactions method.
Version 1.7.1 2021-03-10 New enumeration values were added to the ReferenceTypeEnum for the getTransactions method.
Version 1.7.0 2021-01-06 Adjustment information was added to the TransactionSummaryResponse and the TransactionTypeEnum.
Version 1.6.0 2020-12-14 Increased the maximum value of the limit URI parameter for the getTransactions method from 200 to 1000.
Version 1.5.0 2020-12-01 The transaction method now returns sales record reference information:
  • New values added to TransactionTypeEnum
  • New values added to FeeTypeEnum
  • New TransactionSummaryResponse fields added to getTransactionSummary method
Version 1.4.0 2020-08-21 Currency conversion for Active Cross-Border Trade enabled, and new transfer resource and getTransfer endpoint added to API.
Version 1.3.0 2020-07-09 New TRANSFER transaction type added to getTransactions and getTransactionSummary.

Version 1.11.0

New Features

The following new feature was added with this release.

getTransactions method now returns region-specific income and withholding taxes

The getTransactions method now returns mandatory region-specific fees that are automatically deducted from sellers' payouts.

To support this feature, the new response container feeJurisdiction has been added to getTransactions. feeJurisdiction includes the following fields which provide information about region-specific fees that are charged to sellers:

  • regionType: Enumeration value that returns the type of region that is collecting the corresponding fee.
  • regionName: String value that indicates the name of the region to which a region-specific fee applies.

New RegionTypeEnum

RegionTypeEnum is a new type used to indicate the type of governing jurisdiction requiring the fee to be deducted from a seller's payout.

New enumeration values added to FeeTypeEnum

The following three enumeration values have been added to FeeTypeEnum:

  • INCOME_TAX_WITHHOLDING: the required income tax amount that has been deducted.
  • TAX_DEDUCTION_AT_SOURCE: the required tax amount that has been deducted.
  • VAT_WITHHOLDING: the required VAT amount that has been deducted.

Version 1.10.0

New Features

The following new feature was added with this release

New WITHDRAWAL transaction type added to getTransactions and getTransactionSummary

A new transaction type, WITHDRAWAL, is now supported by the getTransactions and getTransactionSummary methods. This new type tracks on-demand payout information. With on-demand payouts, the seller can withdraw money from the available funds balance.

Note: The WITHDRAWAL transaction type is currently only available to a limited set of sellers.

To support this new feature, the following schema was added:

  • getTransactionSummary has added the following response fields:
    • withdrawalCount: total withdrawal count initiated by the seller.
    • withdrawalAmount: total withdrawal amount for all withdrawals initiated by the seller.
    • withdrawalBookingEntry: the enum value here indicates whether it is a debit or a credit.
  • TransactionTypeEnum a new WITHDRAWAL value was added to this type. This value may be used in a getTransactions or getTransactionSummary method if transactionType is used as a filter in these methods.

New enumeration value added to ReferenceTypeEnum

Additional support for the getTransactions method response has been added with the following new enumeration value added to the ReferenceTypeEnum:

  • PAYOUT_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a payout.

Version 1.9.0

New Features

The following new features were added with this release.

The bankReference and payoutMemo fields were added to the outputs of the getPayout and getPayouts methods.

The bankReference field provides information passed on by the bank, such as how the transaction will appear in the seller's bank statement.

The payoutMemo field contains such information as when the payout is expected to occur.

Version 1.8.0

New Features

The following new features were added with this release.

New feeMemo field added to the Fee type

To provide details of the fees that are automatically deducted from seller payouts, a new feeMemo field is now returned for the Fee type in the getTransactions method response. 

Version 1.7.1

New Features

The following new features were added with this release.

New enumeration values added to the ReferenceTypeEnum

To support the new reference types returned in the getTransactions method response, five new enumeration values were added to the ReferenceTypeEnum:

  • CANCELLATION_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a cancellation.
  • CASE_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a case.
  • PAYMENTS_DISPUTE_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a payment dispute.
  • REFUND_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a refund.
  • RETURN_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a return.

Note: The referenceType indicated by the these enumeration values identifies the reference type associated with the ID that is returned in the referenceId field.

Version 1.7.0

New Features

The following new features were added with this release.

The getTransactionSummary method now returns adjustment information

To provide information on transactions that contain adjustments, a new enumeration value was added to the TransactionTypeEnum:

ADJUSTMENT: enumeration value indicates that the monetary transaction type is an adjustment to the seller's account.

When the getTransactionSummary method is called, the TransactionSummaryResponse field now returns the following additional fields:

  • >adjustmentAmount
  • adjustmentBookingEntry
  • adjustmentCount

Version 1.6.0

The following update was made to this release.

Limit of monetary transactions displayed increased from 200 to 1000 for the getTransactions method

The limit of the number of monetary transactions to return per page has been increased from 200 to 1000 for the getTransactions method.

Version 1.5.0

New Features

The following new features were added with this release.

The transaction method now returns sales record reference information

To provide information on transactions that contain non-transactional seller fees, a new enum value was added to the TransactionTypeEnum:

  • NON_SALE_CHARGE: enumeration value indicates that the monetary transaction involves a seller transferring money to eBay for the balance of a charge. These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.

The Reference field is now returned for a new transaction type (NON_SALE_CHARGE transactions). When the transaction method is called, the Reference field returns with the following properties:

  • referenceId
  • referenceType

New values added to FeeTypeEnum:

New values (35 new enumeration values) were added to the FeeTypeEnum (the new enumerations values below are in bold type; existing values have asterisks *):

  • AD_FEE
  • AUCTION_END_EARLY_FEE
  • BELOW_STANDARD_FEE*
  • BELOW_STANDARD_SHIPPING_FEE*
  • BOLD_FEE
  • BUY_IT_NOW_FEE
  • CATEGORY_FEATURED_FEE
  • CO_FUNDING_COUPON_FEE
  • EBAY_MOTORS_PRO_FEE
  • EBAY_PLUS_SUBSCRIPTION_FEE
  • EBAY_STORE_SUBSCRIPTION_FEE
  • FEATURED_GALLERY_FEE
  • FINAL_VALUE_FEE*
  • FINAL_VALUE_FEE_FIXED_PER_ORDER*
  • FINAL_VALUE_SHIPPING_FEE*
  • FINANCE_FEE
  • GALLERY_FEE
  • GALLERY_PLUS_FEE
  • HIGH_ITEM_NOT_AS_DESCRIBED_FEE*
  • HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE*
  • INSERTION_FEE
  • INTERNATIONAL_FEE*
  • INTERNATIONAL_LISTING_FEE
  • IPIXPHOTO_FEE
  • LARGE_PICTURE_FEE
  • MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE
  • NSFCHECK_FEE
  • OTHER_FEES*
  • PAYMENT_DISPUTE_FEE
  • PAYMENT_PROCESSING_FEE*
  • PREMIUM_AD_FEES
  • PRIVATE_LISTING_FEE
  • PRO_PACK_BUNDLE_FEE
  • PRO_PACK_PLUS_BUNDLE_FEE
  • PROMOTIONAL_CREDIT
  • RESERVE_PRICE_FEE
  • STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE
  • SUBTITLE_FEE
  • VALUE_PACK_BUNDLE_FEE
  • VEHICLE_LOCAL_INSERTION_FEE
  • VEHICLE_LOCAL_SUBSCRIPTION_FEE
  • VEHICLE_SUBSCRIPTION_FEE
  • VEHICLES_BASIC_PACKAGE_FEE
  • VEHICLES_PLUS_PACKAGE_FEE
  • VEHICLES_PREMIUM_PACKAGE_FEE

The getTransactionSummary method now returns additional TransactionSummaryResponse fields

The following TransactionSummaryResponse fields were added to the getTransactionSummary method:

  • nonSaleChargeCount: Total non-sale charge count for given payee within a specified period.
  • nonSaleChargeAmount: Total non-sale charge amount for given payee within a specified period.
  • nonSaleChargeBookingEntry: The credit/debit sign indicator for the non-sale charge.

Version 1.4.0

New Features

The following new features were added with this release

New transfer resource and getTransfer method added

The getTransfer method retrieves detailed information regarding a TRANSFER transaction type. A TRANSFER is a monetary transaction type that involves a seller transferring money to eBay for reimbursement of a charge

The new schema is summarized below:

  • getTransfer: the new endpoint
  • Transfer: this type is used by the base response of the getTransfer method
  • TransferDetail: this type is used to give full details about a specific transfer, including all charges that are a part of the transfer
  • Charge: this type is used to list each charge that is part of the transfer of funds

Currency conversion fields added to Amount type

The capability to do currency conversion for cross-border trade has been enabled for the Finances API. The following three fields were added to Amount type:

  • convertedFromCurrency
  • convertedFromValue
  • exchangeRate

Version 1.3.0

New Features

The following new feature was added with this release

New TRANSFER transaction type added to getTransactions and getTransactionSummary

For managed payments sellers, the new transaction type TRANSFER is available. This new type tracks seller reimbursements to eBay for buyer refunds.

To support this new feature, the following schema was added:

  • getTransactionSummary has added the following response fields:
    • transferAmount: Total transfer amount for given payee within a specified period. Additional supporting fields include currency and value.
    • transferBookingEntry: The credit debit sign indicator for transfer.
    • transferCount: Total transfer count for given payee within a specified period.
  • TransactionTypeEnum type has added the new value TRANSFER. This value indicates that the monetary transaction type involves a seller transferring money to eBay for reimbursement of a buyer refund.
  • TransactionStatusEnum type has added the new values COMPLETED and FAILED. These values indicate whether the monetary transaction type involving a seller transferring money to eBay for reimbursement has completed, or has failed.