ebay.finances
Module ebay.finances
API
Definitions
ballerinax/ebay.finances Ballerina library
Overview
The eBay Finances connector lets Ballerina applications retrieve a seller's payouts, funds, billing activity and monetary transaction details from the eBay Finances API. It supports version v1.19.1 of the API, which is used by sellers to reconcile what eBay has paid out against the individual sales, refunds, fees and transfers behind each payout.
Key features
- Retrieve seller payouts, and look up a single payout by its ID
- Search monetary transactions by date, type or payout, and summarise them for a period
- Review the funds available, processing and on hold in the seller's account
- Inspect order-level earnings, including gross amounts, expenses and refunds
- Access billing activity such as the fees eBay charged, and the details of a transfer
Setup guide
To use the connector, you need an eBay developer account and a user access token that grants the sell.finances scope.
-
Sign up for the eBay Developers Program and sign in.
-
Open the Application Keys page and create a keyset for the Production environment. Note the App ID (Client ID) and the Cert ID (Client Secret).
-
Under User Tokens for the keyset, add an OAuth redirect URL (RuName) for your application.
-
Direct the seller to eBay's consent page using the RuName and the scopes
https://api.ebay.com/oauth/api_scope/sell.financesand, for order earnings,https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read. -
Exchange the authorization code returned to your redirect URL for a user token at
https://api.ebay.com/identity/v1/oauth2/token, and keep the refresh token from the response.
Note: Finances API calls made on behalf of EU and UK sellers also require a digital signature. See eBay's Digital Signatures for APIs guide.
Quickstart
To use the eBay Finances connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/ebay.finances;
Step 2: Create a Config.toml file
clientId = "<Client ID>" clientSecret = "<Client Secret>" refreshToken = "<Refresh Token>"
Step 3: Create a client
configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; final finances:Client ebay = check new ({ auth: {clientId, clientSecret, refreshToken} });
Step 4: Invoke an operation
public function main() returns error? { finances:PayoutSummaryResponse _ = check ebay->getPayoutSummary({xEBAYCMARKETPLACEID: "EBAY_US"}); }
Examples
The eBay Finances connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Payout reconciliation report - Lists recent payouts and totals the credits and debits of the transactions behind each one.
- Seller fee audit - Combines the funds summary, a transaction summary and the billing activity for a date range to show where fees went.
Clients
ebay.finances: Client
This API is used to retrieve seller payouts and monetary transaction details related to those payouts.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://apiz.ebay.com/sell/finances/v1" - URL of the target service
listOrderEarnings
function listOrderEarnings(ListOrderEarningsHeaders headers, *ListOrderEarningsQueries queries) returns OrderEarnings|errorList order earnings
Parameters
- headers ListOrderEarningsHeaders - Headers to be sent with the request
- queries *ListOrderEarningsQueries - Queries to be sent with the request
Return Type
- OrderEarnings|error - The retrieved order earnings
getOrderEarning
function getOrderEarning(string orderId, GetOrderEarningHeaders headers) returns OrderEarning|errorGet order earnings by order ID
Parameters
- orderId string - This path parameter identifies the specific order for which earnings information is requested
- headers GetOrderEarningHeaders - Headers to be sent with the request
Return Type
- OrderEarning|error - The retrieved order earning
getOrderEarningsSummary
function getOrderEarningsSummary(GetOrderEarningsSummaryHeaders headers, *GetOrderEarningsSummaryQueries queries) returns OrderEarningsSummary|errorGet order earnings summary
Parameters
- headers GetOrderEarningsSummaryHeaders - Headers to be sent with the request
- queries *GetOrderEarningsSummaryQueries - Queries to be sent with the request
Return Type
- OrderEarningsSummary|error - The retrieved order earnings summary
getPayout
function getPayout(string payoutId, GetPayoutHeaders headers) returns Payout|errorGet a payout
Parameters
- payoutId string - This path parameter is used to specify the unique identifier of the payout being retrieved. <br><br>Use the <a href="/develop/api/sell/finances_api#sell-finances_api-payout-getpayouts">getPayouts</a> method to retrieve payout IDs, or check Seller Hub to get the payout ID.
- headers GetPayoutHeaders - Headers to be sent with the request
listPayouts
function listPayouts(ListPayoutsHeaders headers, *ListPayoutsQueries queries) returns Payouts|error?List payouts
Parameters
- headers ListPayoutsHeaders - Headers to be sent with the request
- queries *ListPayoutsQueries - Queries to be sent with the request
getPayoutSummary
function getPayoutSummary(GetPayoutSummaryHeaders headers, *GetPayoutSummaryQueries queries) returns PayoutSummaryResponse|errorGet payout summary
Parameters
- headers GetPayoutSummaryHeaders - Headers to be sent with the request
- queries *GetPayoutSummaryQueries - Queries to be sent with the request
Return Type
- PayoutSummaryResponse|error - The retrieved payout summary
getSellerFundsSummary
function getSellerFundsSummary(GetSellerFundsSummaryHeaders headers) returns SellerFundsSummaryResponse|error?Get seller funds summary
Parameters
- headers GetSellerFundsSummaryHeaders - Headers to be sent with the request
Return Type
- SellerFundsSummaryResponse|error? - The retrieved seller funds summary
listTransactions
function listTransactions(ListTransactionsHeaders headers, *ListTransactionsQueries queries) returns Transactions|error?List transactions
Parameters
- headers ListTransactionsHeaders - Headers to be sent with the request
- queries *ListTransactionsQueries - Queries to be sent with the request
Return Type
- Transactions|error? - The retrieved transactions
getTransactionSummary
function getTransactionSummary(GetTransactionSummaryHeaders headers, *GetTransactionSummaryQueries queries) returns TransactionSummaryResponse|errorGet transaction summary
Parameters
- headers GetTransactionSummaryHeaders - Headers to be sent with the request
- queries *GetTransactionSummaryQueries - Queries to be sent with the request
Return Type
- TransactionSummaryResponse|error - The retrieved transaction summary
getTransfer
function getTransfer(string transferId, GetTransferHeaders headers) returns Transfer|errorGet a transfer
Parameters
- transferId string - This path parameter is used to specify the unique identifier of the <code>TRANSFER</code> transaction type you wish to retrieve.<br><br>Use the <a href="/develop/api/sell/finances_api#sell-finances_api-transaction-gettransactions">getTransactions</a> method to retrieve this value by setting the <b>transactionType</b> filter to <code>TRANSFER</code>. The <b>transfer_id</b> value will then be returned in the <b>transaction_id</b> field of the response
- headers GetTransferHeaders - Headers to be sent with the request
listBillingActivities
function listBillingActivities(ListBillingActivitiesHeaders headers, *ListBillingActivitiesQueries queries) returns BillingActivityResponse|errorList billing activities
Parameters
- headers ListBillingActivitiesHeaders (default {}) - Headers to be sent with the request
- queries *ListBillingActivitiesQueries - Queries to be sent with the request
Return Type
Records
ebay.finances: Amount
This type is used to express the dollar value and currency used for any transaction retrieved with the Finances API, including an order total, a seller payout, a buyer refund, or a seller credit
Fields
- convertedToValue? string - <span class="tablenote"><b>Note:</b> This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response <b>only</b> returns value in CNY.</span><br>The monetary value after any conversion is performed, in the currency specified by the <b>convertedToCurrency</b> field. This value is the converted amount. <br/><br/>The field is only returned for payouts to bank accounts when currency conversion was applied by eBay
- convertedFromCurrency? CurrencyCodeEnum - This enumerated type lists the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> code representing the supported world currencies.
| - AED: United Arab Emirates Dirham
- AFN: Afghan Afghani
- ALL: Albanian Lek
- AMD: Armenian Dram
- AOA: Angolan Kwanza
- ARS: Argentine Peso
- AWG: Aruban Florin
- AZN: Azerbaijani Manat
- BAM: Bosnia-Herzegovina Convertible Mark
- BBD: Barbadian Dollar
- BDT: Bangladeshi Taka
- BGN: Bulgarian Lev
- BHD: Bahraini Dinar
- BIF: Burundian Franc
- BMD: Bermudian Dollar
- BND: Brunei Dollar
- BOB: Bolivian Boliviano
- BRL: Brazilian Real
- BSD: Bahamian Dollar
- BTN: Bhutanese Ngultrum
- BWP: Botswanan Pula
- BYR: Belarusian Ruble
- BZD: Belize Dollar
- CAD: Canadian Dollar
- CDF: Congolese Franc
- CLP: Chilean Peso
- CNY: Chinese Yuan
- COP: Colombian Peso
- CRC: Costa Rican Colon
- CUP: Cuban Peso
- CVE: Cape Verdean Escudo
- CZK: Czech Koruna
- DJF: Djiboutian Franc
- DOP: Dominican Peso
- DZD: Algerian Dinar
- EGP: Egyptian Pound
- ERN: Eritrean Nakfa
- ETB: Ethiopian Birr
- FJD: Fijian Dollar
- FKP: Falkland Islands Pound
- GEL: Georgian Lari
- GHS: Ghanaian Cedi
- GIP: Gibraltar Pound
- DKK: Danish Krone
- GMD: Gambian Dalasi
- GNF: Guinean Franc
- GTQ: Guatemalan Quetzal
- GYD: Guyanaese Dollar
- HKD: Hong Kong Dollar
- HNL: Honduran Lempira
- HRK: Croatian Kuna
- HTG: Haitian Gourde
- HUF: Hungarian Forint
- IDR: Indonesian Rupiah
- INR: Indian Rupee
- IQD: Iraqi Dinar
- IRR: Iranian Rial
- ISK: Icelandic Krona
- GBP: British Pound Sterling
- JMD: Jamaican Dollar
- JOD: Jordanian Dinar
- JPY: Japanese Yen
- KES: Kenyan Shilling
- KGS: Kyrgystani Som
- KHR: Cambodian Riel
- KMF: Comorian Franc
- KPW: North Korean Won
- KRW: South Korean Won
- KWD: Kuwaiti Dinar
- KYD: Cayman Islands Dollar
- KZT: Kazakhstani Tenge
- LAK: Laotian Kip
- LBP: Lebanese Pound
- CHF: Swiss Franc
- LKR: Sri Lankan Rupee
- LRD: Liberian Dollar
- LSL: Lesotho Loti
- LTL: Lithuanian Litas
- LYD: Libyan Dinar
- MAD: Moroccan Dirham
- MDL: Moldovan Leu
- MGA: Malagasy Ariary
- MKD: Macedonian Denar
- MMK: Myanma Kyat
- MNT: Mongolian Tugrik
- MOP: Macanese Pataca
- MRO: Mauritanian Ouguiya
- XCD: East Caribbean Dollar
- MUR: Mauritian Rupee
- MVR: Maldivian Rufiyaa
- MWK: Malawian Kwacha
- MXN: Mexican Peso
- MYR: Malaysian Ringgit
- MZN: Mozambican Metical
- NAD: Namibian Dollar
- NGN: Nigerian Naira
- NIO: Nicaraguan Cordoba
- NPR: Nepalese Rupee
- OMR: Omani Rial
- PAB: Panamanian Balboa
- PEN: Peruvian Nuevo Sol
- XPF: CFP Franc
- PGK: Papua New Guinean Kina
- PHP: Philippine Peso
- PKR: Pakistani Rupee
- PLN: Polish Zloty
- ILS: Israeli New Sheqel
- PYG: Paraguayan Guarani
- QAR: Qatari Rial
- RON: Romanian Leu
- RSD: Serbian Dinar
- RUB: Russian Ruble
- RWF: Rwandan Franc
- SAR: Saudi Riyal
- SBD: Solomon Islands Dollar
- SCR: Seychellois Rupee
- SDG: Sudanese Pound
- SEK: Swedish Krona
- SGD: Singapore Dollar
- SHP: Saint Helena Pound
- NOK: Norwegian Krone
- SLL: Sierra Leonean Leone
- SOS: Somali Shilling
- SRD: Surinamese Dollar
- STD: Sao Tome and Principe Dobra
- ANG: Netherlands Antillean Guilder
- SYP: Syrian Pound
- SZL: Swazi Lilangeni
- XAF: CFA Franc BEAC
- XOF: CFA Franc BCEAO
- THB: Thai Baht
- TJS: Tajikistani Somoni
- NZD: New Zealand Dollar
- TMT: Turkmenistani Manat
- TND: Tunisian Dinar
- TOP: Tongan Paanga
- TRY: Turkish Lira
- TTD: Trinidad and Tobago Dollar
- AUD: Australian Dollar
- TWD: New Taiwan Dollar
- TZS: Tanzanian Shilling
- UAH: Ukrainian Hryvnia
- UGX: Ugandan Shilling
- USD: United States Dollar
- UYU: Uruguayan Peso
- UZS: Uzbekistan Som
- VEF: Venezuelan Bolivar Fuerte
- VND: Vietnamese Dong
- VUV: Vanuatu Vatu
- WST: Samoan Tala
- YER: Yemeni Rial
- EUR: Euro
- ZAR: South African Rand
- ZMW: Zambian Kwacha
- ZWL: Zimbabwean Dollar
- exchangeRate? string - The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the <b>value</b> field from the dollar value in the <b>convertedFromValue</b> field.<br><br> For sellers in mainland China, this field shows the exchange rate to convert the dollar value in the <b>value</b> field to the CNY value in the <b>convertedToValue</b> field.<br><br>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. <br><br>This field is only returned if/when currency conversion was applied by eBay
- convertedToCurrency? CurrencyCodeEnum - This enumerated type lists the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> code representing the supported world currencies.
| - AED: United Arab Emirates Dirham
- AFN: Afghan Afghani
- ALL: Albanian Lek
- AMD: Armenian Dram
- AOA: Angolan Kwanza
- ARS: Argentine Peso
- AWG: Aruban Florin
- AZN: Azerbaijani Manat
- BAM: Bosnia-Herzegovina Convertible Mark
- BBD: Barbadian Dollar
- BDT: Bangladeshi Taka
- BGN: Bulgarian Lev
- BHD: Bahraini Dinar
- BIF: Burundian Franc
- BMD: Bermudian Dollar
- BND: Brunei Dollar
- BOB: Bolivian Boliviano
- BRL: Brazilian Real
- BSD: Bahamian Dollar
- BTN: Bhutanese Ngultrum
- BWP: Botswanan Pula
- BYR: Belarusian Ruble
- BZD: Belize Dollar
- CAD: Canadian Dollar
- CDF: Congolese Franc
- CLP: Chilean Peso
- CNY: Chinese Yuan
- COP: Colombian Peso
- CRC: Costa Rican Colon
- CUP: Cuban Peso
- CVE: Cape Verdean Escudo
- CZK: Czech Koruna
- DJF: Djiboutian Franc
- DOP: Dominican Peso
- DZD: Algerian Dinar
- EGP: Egyptian Pound
- ERN: Eritrean Nakfa
- ETB: Ethiopian Birr
- FJD: Fijian Dollar
- FKP: Falkland Islands Pound
- GEL: Georgian Lari
- GHS: Ghanaian Cedi
- GIP: Gibraltar Pound
- DKK: Danish Krone
- GMD: Gambian Dalasi
- GNF: Guinean Franc
- GTQ: Guatemalan Quetzal
- GYD: Guyanaese Dollar
- HKD: Hong Kong Dollar
- HNL: Honduran Lempira
- HRK: Croatian Kuna
- HTG: Haitian Gourde
- HUF: Hungarian Forint
- IDR: Indonesian Rupiah
- INR: Indian Rupee
- IQD: Iraqi Dinar
- IRR: Iranian Rial
- ISK: Icelandic Krona
- GBP: British Pound Sterling
- JMD: Jamaican Dollar
- JOD: Jordanian Dinar
- JPY: Japanese Yen
- KES: Kenyan Shilling
- KGS: Kyrgystani Som
- KHR: Cambodian Riel
- KMF: Comorian Franc
- KPW: North Korean Won
- KRW: South Korean Won
- KWD: Kuwaiti Dinar
- KYD: Cayman Islands Dollar
- KZT: Kazakhstani Tenge
- LAK: Laotian Kip
- LBP: Lebanese Pound
- CHF: Swiss Franc
- LKR: Sri Lankan Rupee
- LRD: Liberian Dollar
- LSL: Lesotho Loti
- LTL: Lithuanian Litas
- LYD: Libyan Dinar
- MAD: Moroccan Dirham
- MDL: Moldovan Leu
- MGA: Malagasy Ariary
- MKD: Macedonian Denar
- MMK: Myanma Kyat
- MNT: Mongolian Tugrik
- MOP: Macanese Pataca
- MRO: Mauritanian Ouguiya
- XCD: East Caribbean Dollar
- MUR: Mauritian Rupee
- MVR: Maldivian Rufiyaa
- MWK: Malawian Kwacha
- MXN: Mexican Peso
- MYR: Malaysian Ringgit
- MZN: Mozambican Metical
- NAD: Namibian Dollar
- NGN: Nigerian Naira
- NIO: Nicaraguan Cordoba
- NPR: Nepalese Rupee
- OMR: Omani Rial
- PAB: Panamanian Balboa
- PEN: Peruvian Nuevo Sol
- XPF: CFP Franc
- PGK: Papua New Guinean Kina
- PHP: Philippine Peso
- PKR: Pakistani Rupee
- PLN: Polish Zloty
- ILS: Israeli New Sheqel
- PYG: Paraguayan Guarani
- QAR: Qatari Rial
- RON: Romanian Leu
- RSD: Serbian Dinar
- RUB: Russian Ruble
- RWF: Rwandan Franc
- SAR: Saudi Riyal
- SBD: Solomon Islands Dollar
- SCR: Seychellois Rupee
- SDG: Sudanese Pound
- SEK: Swedish Krona
- SGD: Singapore Dollar
- SHP: Saint Helena Pound
- NOK: Norwegian Krone
- SLL: Sierra Leonean Leone
- SOS: Somali Shilling
- SRD: Surinamese Dollar
- STD: Sao Tome and Principe Dobra
- ANG: Netherlands Antillean Guilder
- SYP: Syrian Pound
- SZL: Swazi Lilangeni
- XAF: CFA Franc BEAC
- XOF: CFA Franc BCEAO
- THB: Thai Baht
- TJS: Tajikistani Somoni
- NZD: New Zealand Dollar
- TMT: Turkmenistani Manat
- TND: Tunisian Dinar
- TOP: Tongan Paanga
- TRY: Turkish Lira
- TTD: Trinidad and Tobago Dollar
- AUD: Australian Dollar
- TWD: New Taiwan Dollar
- TZS: Tanzanian Shilling
- UAH: Ukrainian Hryvnia
- UGX: Ugandan Shilling
- USD: United States Dollar
- UYU: Uruguayan Peso
- UZS: Uzbekistan Som
- VEF: Venezuelan Bolivar Fuerte
- VND: Vietnamese Dong
- VUV: Vanuatu Vatu
- WST: Samoan Tala
- YER: Yemeni Rial
- EUR: Euro
- ZAR: South African Rand
- ZMW: Zambian Kwacha
- ZWL: Zimbabwean Dollar
- currency CurrencyCodeEnum - This enumerated type lists the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> code representing the supported world currencies.
| - AED: United Arab Emirates Dirham
- AFN: Afghan Afghani
- ALL: Albanian Lek
- AMD: Armenian Dram
- AOA: Angolan Kwanza
- ARS: Argentine Peso
- AWG: Aruban Florin
- AZN: Azerbaijani Manat
- BAM: Bosnia-Herzegovina Convertible Mark
- BBD: Barbadian Dollar
- BDT: Bangladeshi Taka
- BGN: Bulgarian Lev
- BHD: Bahraini Dinar
- BIF: Burundian Franc
- BMD: Bermudian Dollar
- BND: Brunei Dollar
- BOB: Bolivian Boliviano
- BRL: Brazilian Real
- BSD: Bahamian Dollar
- BTN: Bhutanese Ngultrum
- BWP: Botswanan Pula
- BYR: Belarusian Ruble
- BZD: Belize Dollar
- CAD: Canadian Dollar
- CDF: Congolese Franc
- CLP: Chilean Peso
- CNY: Chinese Yuan
- COP: Colombian Peso
- CRC: Costa Rican Colon
- CUP: Cuban Peso
- CVE: Cape Verdean Escudo
- CZK: Czech Koruna
- DJF: Djiboutian Franc
- DOP: Dominican Peso
- DZD: Algerian Dinar
- EGP: Egyptian Pound
- ERN: Eritrean Nakfa
- ETB: Ethiopian Birr
- FJD: Fijian Dollar
- FKP: Falkland Islands Pound
- GEL: Georgian Lari
- GHS: Ghanaian Cedi
- GIP: Gibraltar Pound
- DKK: Danish Krone
- GMD: Gambian Dalasi
- GNF: Guinean Franc
- GTQ: Guatemalan Quetzal
- GYD: Guyanaese Dollar
- HKD: Hong Kong Dollar
- HNL: Honduran Lempira
- HRK: Croatian Kuna
- HTG: Haitian Gourde
- HUF: Hungarian Forint
- IDR: Indonesian Rupiah
- INR: Indian Rupee
- IQD: Iraqi Dinar
- IRR: Iranian Rial
- ISK: Icelandic Krona
- GBP: British Pound Sterling
- JMD: Jamaican Dollar
- JOD: Jordanian Dinar
- JPY: Japanese Yen
- KES: Kenyan Shilling
- KGS: Kyrgystani Som
- KHR: Cambodian Riel
- KMF: Comorian Franc
- KPW: North Korean Won
- KRW: South Korean Won
- KWD: Kuwaiti Dinar
- KYD: Cayman Islands Dollar
- KZT: Kazakhstani Tenge
- LAK: Laotian Kip
- LBP: Lebanese Pound
- CHF: Swiss Franc
- LKR: Sri Lankan Rupee
- LRD: Liberian Dollar
- LSL: Lesotho Loti
- LTL: Lithuanian Litas
- LYD: Libyan Dinar
- MAD: Moroccan Dirham
- MDL: Moldovan Leu
- MGA: Malagasy Ariary
- MKD: Macedonian Denar
- MMK: Myanma Kyat
- MNT: Mongolian Tugrik
- MOP: Macanese Pataca
- MRO: Mauritanian Ouguiya
- XCD: East Caribbean Dollar
- MUR: Mauritian Rupee
- MVR: Maldivian Rufiyaa
- MWK: Malawian Kwacha
- MXN: Mexican Peso
- MYR: Malaysian Ringgit
- MZN: Mozambican Metical
- NAD: Namibian Dollar
- NGN: Nigerian Naira
- NIO: Nicaraguan Cordoba
- NPR: Nepalese Rupee
- OMR: Omani Rial
- PAB: Panamanian Balboa
- PEN: Peruvian Nuevo Sol
- XPF: CFP Franc
- PGK: Papua New Guinean Kina
- PHP: Philippine Peso
- PKR: Pakistani Rupee
- PLN: Polish Zloty
- ILS: Israeli New Sheqel
- PYG: Paraguayan Guarani
- QAR: Qatari Rial
- RON: Romanian Leu
- RSD: Serbian Dinar
- RUB: Russian Ruble
- RWF: Rwandan Franc
- SAR: Saudi Riyal
- SBD: Solomon Islands Dollar
- SCR: Seychellois Rupee
- SDG: Sudanese Pound
- SEK: Swedish Krona
- SGD: Singapore Dollar
- SHP: Saint Helena Pound
- NOK: Norwegian Krone
- SLL: Sierra Leonean Leone
- SOS: Somali Shilling
- SRD: Surinamese Dollar
- STD: Sao Tome and Principe Dobra
- ANG: Netherlands Antillean Guilder
- SYP: Syrian Pound
- SZL: Swazi Lilangeni
- XAF: CFA Franc BEAC
- XOF: CFA Franc BCEAO
- THB: Thai Baht
- TJS: Tajikistani Somoni
- NZD: New Zealand Dollar
- TMT: Turkmenistani Manat
- TND: Tunisian Dinar
- TOP: Tongan Paanga
- TRY: Turkish Lira
- TTD: Trinidad and Tobago Dollar
- AUD: Australian Dollar
- TWD: New Taiwan Dollar
- TZS: Tanzanian Shilling
- UAH: Ukrainian Hryvnia
- UGX: Ugandan Shilling
- USD: United States Dollar
- UYU: Uruguayan Peso
- UZS: Uzbekistan Som
- VEF: Venezuelan Bolivar Fuerte
- VND: Vietnamese Dong
- VUV: Vanuatu Vatu
- WST: Samoan Tala
- YER: Yemeni Rial
- EUR: Euro
- ZAR: South African Rand
- ZMW: Zambian Kwacha
- ZWL: Zimbabwean Dollar
- convertedFromValue? string - The monetary amount before any conversion is performed, in the currency specified by the <b> convertedFromCurrency</b> field. This value is the pre-conversion amount. The <b> value</b> field contains the converted amount of this value, in the currency specified by the <b> currency</b> field.<br><br>This field is only returned if/when currency conversion was applied by eBay
- value string - The monetary amount, in the currency specified by the <b>currency</b> field. This field is always returned with any container using <b>Amount</b> type
ebay.finances: BalanceAdjustment
This type is used by the balanceAdjustment container, which shows the seller payout balance that will be applied toward the charges outlined in the charges array
Fields
- adjustmentType? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- adjustmentAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: BillingActivityLineItem
This type defines the fees, credits, and promotional offers applied to a seller's account
Fields
- bookingEntry string - The value returned in this field will indicate if the billing transaction is a debit against the seller's account, or a credit. A debit is much more prevalent than a credit, but sometimes a listing fee will get reversed and they will get a credit for this fee. Possible values:<br><ul><li><code>DEBIT</code></li><li><code>CREDIT</code></li></ul>
- feeTypeDescription string - This field contains the human-readable description of the fee type associated with the transaction. For example, <code>Final Value Fee</code>
- amount Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- orderId? string - The unique identifier of the eBay order associated with the billing transaction. This field is returned if the fee is associated with an order
- billingTransactionId string - This field provides a unique identifier of the billing transaction. If a seller wants to view details on a specific billing transaction, they can use the <b>actvityId</b> filter and pass in a specific <b>billingTransactionId</b> value
- promotionalOffers? DiscountDetail[] - A list of seller promotional offers applicable for the billing transaction
- listingId? string - The unique identifier of the eBay listing associated with the billing transaction. This field is returned if the fee is associated with a listing
- feeType string - This field describes the type of fee associated with the transaction. An example value is <code>FinalValueFeeFixedFeePerOrder</code>
- billingTransactionDate string - This timestamp indicates the date/time when eBay processed the transaction
ebay.finances: BillingActivityResponse
This type is the base response type used by the getBillingActivities method.
Fields
- next? string - The URI for the next page of results starting with the resource name. This URI is returned if there is an additional page of results in the result set
- total Signed32 - The total number of billing transactions available that match the filter criteria. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>When the <b>total</b> value exceeds the <b>limit</b> value, there are multiple pages of results.</span></p>
- offset Signed32 - The value of the <b>offset</b> parameter. This field indicates how many results were skipped in the response. If an <b>offset</b> parameter was not included in the request, this value will default to <code>0</code>, returning the first page of results
- prev? string - The URI for the previous page of results starting with the resource name. This URI is returned if there is a previous page of results in the result set
- billingActivities BillingActivityLineItem[] - A list of billing activity entries that meet the filter criteria. Billing activity will include fees, credits, and promotional offers applied to the seller's account
- count Signed32 - An integer representing the number of billing activity items returned in this response page
- 'limit Signed32 - The value of the <b>limit</b> parameter. This is the maximum number of line items, as filtered, of billing transactions to return per page from the result set
ebay.finances: Buyer
This type is used to express details about the buyer associated with an order. At this time, the only field in this type is the eBay user ID of the buyer, but more fields may get added at a later date
Fields
- username string - The eBay user ID of the order's buyer.<br><br><span class="tablenote"><b>Note:</b> Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to <a href="/api-docs/static/data-handling-update.html" target="_blank">Data Handling Compliance</a>. </span>
ebay.finances: BuyerWithId
This type defines identifying information about the buyer associated with an order
Fields
- userId? string - The public user ID of the buyer
- username? string - The username of the buyer. <br><br><span class="tablenote"><b>Note:</b> Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to <a href="/api-docs/static/data-handling-update.html" target="_blank">Data Handling Compliance</a>. </span>
ebay.finances: Charge
This type is used by the charge container, which is an array of one or more charges related to the transfer
Fields
- chargeNetAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- inquiryId? string - The unique identifier of an Item Not Received (INR) inquiry filed against an order. This field is only applicable and returned if the charge is related to has an INR inquiry filed against the order
- orderId? string - The unique identifier of the order that is associated with the charge
- paymentDisputeId? string - The unique identifier of a third-party payment dispute filed against an order. This occurs when the buyer files a dispute against the order with their payment provider, and then the dispute comes into eBay's system. This field is only applicable and returned if the charge is related to a third-party payment dispute filed against an order
- caseId? string - The unique identifier of a case filed against an order. This field is only applicable and returned if the charge is related to a case filed against an order
- returnId? string - The unique identifier of an order return. This field is only applicable and returned if the charge is related to an order that was returned by the buyer
- cancellationId? string - The unique identifier of an order cancellation. This field is only applicable and returned if the charge is related to an order cancellation
- refundId? string - The unique identifier of a buyer refund associated with the charge
ebay.finances: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ebay.finances: DiscountDetail
This type shows the amount of the promotional offer
Fields
- offerType? string - The type of promotional discount applied through the activity's promotional offer <b>amount</b>. Examples include offer types such as <code>ETRS</code> (eBay Top Rated Seller) and <code>PROMOTION</code>
- amount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: EarningsSummary
This type defines a summarized view of earnings information derived from one order. It defines fields that provides a summarized view of earnings information derived from one order including aggregated financial values for gross amount, expenses, earnings, and refunds.
Fields
- grossAmount Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- orderEarnings Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- expenses? Expense - This type defines provides the total expenses associated with an order. Expenses represent cost components that reduce the seller's gross earnings and may include deductions such as marketplace fees, eBay shipping labels, and donations, applied during order processing
- refunds? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: Expense
This type defines provides the total expenses associated with an order. Expenses represent cost components that reduce the seller's gross earnings and may include deductions such as marketplace fees, eBay shipping labels, and donations, applied during order processing
Fields
- donations? OrderEarningFee[] - This array shows the amount(s) of one or more donations that are submitted to eBay charity organizations for one or more orders. <br><p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Donations are always tied to specific items. When an item is listed with a charity contribution (for example, 10%), the donation is calculated per item at the time of sale. Order earnings factor in only the items within the order that are eligible for donation.</span></p>
- marketplaceFees? OrderEarningFee[] - This array shows the type and amount(s) of marketplace fees that were charged against one or more orders
- currency? CurrencyCodeEnum - This enumerated type lists the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> code representing the supported world currencies.
| - AED: United Arab Emirates Dirham
- AFN: Afghan Afghani
- ALL: Albanian Lek
- AMD: Armenian Dram
- AOA: Angolan Kwanza
- ARS: Argentine Peso
- AWG: Aruban Florin
- AZN: Azerbaijani Manat
- BAM: Bosnia-Herzegovina Convertible Mark
- BBD: Barbadian Dollar
- BDT: Bangladeshi Taka
- BGN: Bulgarian Lev
- BHD: Bahraini Dinar
- BIF: Burundian Franc
- BMD: Bermudian Dollar
- BND: Brunei Dollar
- BOB: Bolivian Boliviano
- BRL: Brazilian Real
- BSD: Bahamian Dollar
- BTN: Bhutanese Ngultrum
- BWP: Botswanan Pula
- BYR: Belarusian Ruble
- BZD: Belize Dollar
- CAD: Canadian Dollar
- CDF: Congolese Franc
- CLP: Chilean Peso
- CNY: Chinese Yuan
- COP: Colombian Peso
- CRC: Costa Rican Colon
- CUP: Cuban Peso
- CVE: Cape Verdean Escudo
- CZK: Czech Koruna
- DJF: Djiboutian Franc
- DOP: Dominican Peso
- DZD: Algerian Dinar
- EGP: Egyptian Pound
- ERN: Eritrean Nakfa
- ETB: Ethiopian Birr
- FJD: Fijian Dollar
- FKP: Falkland Islands Pound
- GEL: Georgian Lari
- GHS: Ghanaian Cedi
- GIP: Gibraltar Pound
- DKK: Danish Krone
- GMD: Gambian Dalasi
- GNF: Guinean Franc
- GTQ: Guatemalan Quetzal
- GYD: Guyanaese Dollar
- HKD: Hong Kong Dollar
- HNL: Honduran Lempira
- HRK: Croatian Kuna
- HTG: Haitian Gourde
- HUF: Hungarian Forint
- IDR: Indonesian Rupiah
- INR: Indian Rupee
- IQD: Iraqi Dinar
- IRR: Iranian Rial
- ISK: Icelandic Krona
- GBP: British Pound Sterling
- JMD: Jamaican Dollar
- JOD: Jordanian Dinar
- JPY: Japanese Yen
- KES: Kenyan Shilling
- KGS: Kyrgystani Som
- KHR: Cambodian Riel
- KMF: Comorian Franc
- KPW: North Korean Won
- KRW: South Korean Won
- KWD: Kuwaiti Dinar
- KYD: Cayman Islands Dollar
- KZT: Kazakhstani Tenge
- LAK: Laotian Kip
- LBP: Lebanese Pound
- CHF: Swiss Franc
- LKR: Sri Lankan Rupee
- LRD: Liberian Dollar
- LSL: Lesotho Loti
- LTL: Lithuanian Litas
- LYD: Libyan Dinar
- MAD: Moroccan Dirham
- MDL: Moldovan Leu
- MGA: Malagasy Ariary
- MKD: Macedonian Denar
- MMK: Myanma Kyat
- MNT: Mongolian Tugrik
- MOP: Macanese Pataca
- MRO: Mauritanian Ouguiya
- XCD: East Caribbean Dollar
- MUR: Mauritian Rupee
- MVR: Maldivian Rufiyaa
- MWK: Malawian Kwacha
- MXN: Mexican Peso
- MYR: Malaysian Ringgit
- MZN: Mozambican Metical
- NAD: Namibian Dollar
- NGN: Nigerian Naira
- NIO: Nicaraguan Cordoba
- NPR: Nepalese Rupee
- OMR: Omani Rial
- PAB: Panamanian Balboa
- PEN: Peruvian Nuevo Sol
- XPF: CFP Franc
- PGK: Papua New Guinean Kina
- PHP: Philippine Peso
- PKR: Pakistani Rupee
- PLN: Polish Zloty
- ILS: Israeli New Sheqel
- PYG: Paraguayan Guarani
- QAR: Qatari Rial
- RON: Romanian Leu
- RSD: Serbian Dinar
- RUB: Russian Ruble
- RWF: Rwandan Franc
- SAR: Saudi Riyal
- SBD: Solomon Islands Dollar
- SCR: Seychellois Rupee
- SDG: Sudanese Pound
- SEK: Swedish Krona
- SGD: Singapore Dollar
- SHP: Saint Helena Pound
- NOK: Norwegian Krone
- SLL: Sierra Leonean Leone
- SOS: Somali Shilling
- SRD: Surinamese Dollar
- STD: Sao Tome and Principe Dobra
- ANG: Netherlands Antillean Guilder
- SYP: Syrian Pound
- SZL: Swazi Lilangeni
- XAF: CFA Franc BEAC
- XOF: CFA Franc BCEAO
- THB: Thai Baht
- TJS: Tajikistani Somoni
- NZD: New Zealand Dollar
- TMT: Turkmenistani Manat
- TND: Tunisian Dinar
- TOP: Tongan Paanga
- TRY: Turkish Lira
- TTD: Trinidad and Tobago Dollar
- AUD: Australian Dollar
- TWD: New Taiwan Dollar
- TZS: Tanzanian Shilling
- UAH: Ukrainian Hryvnia
- UGX: Ugandan Shilling
- USD: United States Dollar
- UYU: Uruguayan Peso
- UZS: Uzbekistan Som
- VEF: Venezuelan Bolivar Fuerte
- VND: Vietnamese Dong
- VUV: Vanuatu Vatu
- WST: Samoan Tala
- YER: Yemeni Rial
- EUR: Euro
- ZAR: South African Rand
- ZMW: Zambian Kwacha
- ZWL: Zimbabwean Dollar
- value? string - This field shows the total expenses including charges and credits associated for one or more orders based on the order creation time period chosen
- shippingLabels? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: Fee
This type is used for provide information about a fee that is charged against an order
Fields
- amount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- feeJurisdiction? FeeJurisdiction - This type defines the jurisdiction information associated with a fee, identifying the geographic or regulatory region under which the fee is applied
- feeMemo? string - A descriptive message that provides additional context about the fee applied to the order
- feeType? FeeTypeEnum - This enumerated type shows the fees that are automatically deducted from seller payouts. | - BELOW_STANDARD_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the order line item cost. - BELOW_STANDARD_SHIPPING_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the shipping cost for an order line item.<br><br><b>Note</b>: This fee is bundled with the <code>BELOW_STANDARD_FEE</code> and not returned separately. - FINAL_VALUE_FEE_FIXED_PER_ORDER: This fee is a fixed-cost fee charged by eBay for every order (regardless of how many line items are in the order). This fee can vary by country. - FINAL_VALUE_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the order line item cost. The percentage varies by eBay category. - INTERNATIONAL_FEE: This fee is an international fee associated with an order line item if the seller's eBay registered address country is different than the buyer's registered address or delivery address. This fee is calculated as a percentage of the total amount of the order line item. - HIGH_ITEM_NOT_AS_DESCRIBED_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the order line item cost. - HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the shipping cost for the order line item.<br><br><b>Note</b>: This fee is bundled with the <code>HIGH_ITEM_NOT_AS_DESCRIBED_FEE</code> and not returned separately. - PAYMENT_PROCESSING_FEE: This is a payment processing fee charged for each order.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE_FIXED_PER_ORDER</code> and not returned separately. - FINAL_VALUE_SHIPPING_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the shipping cost for the order line item. The percentage varies by eBay category.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE</code> and not returned separately. - INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee for a listing. - BOLD_FEE: This enumeration value indicates that the account entry is a listing upgrade fee or credit for a listing title in boldface font. - FINANCE_FEE: This enumeration value indicates that the account entry is a finance charge to the user's account. - CATEGORY_FEATURED_FEE: This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.<br><br><b>Note</b>: This feature is no longer available to most marketplaces and sellers. - NSFCHECK_FEE: This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear due to insufficient funds. - PROMOTIONAL_CREDIT: This enumeration value indicates that the account entry is a promotional credit issued by eBay. - GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Picture Gallery. - FEATURED_GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Featured section at the top of the Picture Gallery page. - RESERVE_PRICE_FEE: This enumeration value indicates that the account entry is a fee charged or a credit refunded to the seller for a reserve price that was set for an auction listing. - IPIXPHOTO_FEE: This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace. - LARGE_PICTURE_FEE: This enumeration value indicates that the account entry is a fee charged by eBay for a super-sized picture in a listing. - EBAY_STORE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged or a credit issued toward the user's eBay Store. - BUY_IT_NOW_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued by eBay if the seller uses the 'Buy It Now' feature on an auction listing. - SUBTITLE_FEE: This enumeration value indicates the account entry is a fee charged to the seller for adding a subtitle to a listing or a credit issued from eBay. - INTERNATIONAL_LISTING_FEE: This enumeration value indicates that the account entry is a 'cross-border trade' fee or credit. - PRO_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Pro Pack Bundle feature pack. - MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a fee or a credit toward a fee for a Terapeak Research pro subscription. - VEHICLE_LOCAL_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee or a credit toward a monthly subscription fee charged for a National Vehicle subscription. - VEHICLE_LOCAL_INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee or a credit for a Motors local listing. - VALUE_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged or a credit towards the fee charged by eBay to the seller for using the Value Pack Bundle feature pack. - PRO_PACK_PLUS_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack. - GALLERY_PLUS_FEE: This enumeration value indicates that the account entry is a fee charged or a credit towards a fee charged by eBay for listing an item with the Gallery Plus feature. - EBAY_MOTORS_PRO_FEE: This enumeration value indicates that the account entry is an eBay Motors Pro fee or a credit towards an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only. - PRIVATE_LISTING_FEE: This enumeration value indicates that the account entry is a fee for a private listing or a credit towards a fee charged. - AUCTION_END_EARLY_FEE: This enumeration value indicates that the account entry is a fee charged to the seller's account if the seller ends an auction (with bids) early. - STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE: This enumeration value indicates that the account entry is a fee charged or a credit toward a fee charged for early termination of an eBay Stores subscription. - AD_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued for an Ad on eBay. - EBAY_PLUS_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is an annual subscription fee charged a credit toward an annual subscription fee for an eBay Plus subscription. - VEHICLE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged a credit toward a monthly subscription fee for a National Vehicle subscription. - CO_FUNDING_COUPON_FEE: This enumeration value indicates that eBay is billing the seller or giving credit to the seller for a co-funding charge. - PAYMENT_DISPUTE_FEE: This enumeration value indicates the credit is a charge or a seller reimbursement for an eBay payment dispute fee. - PREMIUM_AD_FEES: This enumeration value indicates the invoice charged or the credit issued was for a Premium Ad Fee. - VEHICLES_BASIC_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Basic Package fee. - VEHICLES_PLUS_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Plus Package fee. - VEHICLES_PREMIUM_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Premium Package fee. - DEPOSIT_PROCESSING_FEE: This fee is charged to a seller when they sell a motor vehicle and require a deposit from the buyer. - EXPRESS_PAYOUT_FEE: This is the fee charged by eBay when a seller requests a payout through a debit card.<br><br><b>Note</b>: If the requested payout to a debit card fails, the <code>EXPRESS_PAYOUT_FEE</code> will be credited back to the seller's account. - TAX_DEDUCTION_AT_SOURCE: This enumeration value indicates the account entry is the tax amount automatically deducted from a seller's payout. - INCOME_TAX_WITHHOLDING: This enumeration value indicates the account entry is the required income tax amount deducted from a seller's payout. - VAT_WITHHOLDING: This enumeration value indicates that the account entry is the required VAT amount deducted from the seller's payout. - BANK_PAYOUT_FEE: This enumeration value indicates that a fee is charged by eBay when a seller requests a payout through a bank account.<br><br><b>Note</b>: <code>BANK_PAYOUT_FEE</code> is only applicable for CNY sellers and when the <b>payoutInstrumentType</b> is <code>BANK</code>. - CHARITY_DONATION: This enumeration value indicates the charitable donations against a sale. - REGULATORY_OPERATING_FEE: This enumeration value indicates that a fee is charged by eBay to cover the costs associated with complying with regulatory requirements in specific marketplaces. - OTHER_FEES: This enumeration value may be returned if the fee type cannot be determined, or has not been classified
ebay.finances: FeeJurisdiction
This type defines the jurisdiction information associated with a fee, identifying the geographic or regulatory region under which the fee is applied
Fields
- regionType? RegionTypeEnum - An enumerated value indicating the type of governing jurisdiction requiring the fee to be deducted from a seller's payout. | - COUNTRY: Indicates the governing jurisdiction is a country. - STATE_OR_PROVINCE: Indicates the governing jurisdiction is a state or province
- regionName? string - The name of the region to which the fee applies.<br/><br/>The set of valid <b>regionName</b> values returned is determined by the corresponding <b>regionType</b> value.<br/><br/><span class="tablenote"><strong>Note:</strong> Currently supported <b>regionName</b> values are standard two-character country or state codes.<br/><br/>Typical examples include:<ul><li><b>MX</b> (Mexico)</li><li><b>IN</b> (India)</li><li><b>US</b> (United States)</li><li><b>CA</b> (California)</li><li><b>VT</b> (Vermont)</li><li><b>ME</b> (Maine)</li></ul></span>
ebay.finances: FundingSource
This type defines the source of funds used to finance a transfer, such as available seller funds, a credit card, or a bank account
Fields
- memo? string - This field provides a note about the funding source. If the seller's credit card or bank account is the funding source, this field might contain the last four digits of the credit card or bank account. This field may also be returned as null
- 'type? string - The string value returned here indicates the funding source. Possible values include the following:<ul><li><code>AVAILABLE_FUNDS</code>: transfer is funded with seller payout funds</li><li><code>CREDIT_CARD</code>: transfer is funded with seller's credit card</li><li><code>BANK</code>: transfer is funded with a direct debit to seller's bank account on file with eBay</li><li><code>PAY_UPON_INVOICE</code>: eBay will bill the seller for the transfer on the monthly invoice</li></ul>
- brand? string - The brand name of the credit card or the name of the financial institution that is the source of payment. This field may not be populated for other funding sources
ebay.finances: GetOrderEarningHeaders
Represents the Headers record for the operation: getOrderEarning
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values " target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetOrderEarningsSummaryHeaders
Represents the Headers record for the operation: getOrderEarningsSummary
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values " target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetOrderEarningsSummaryQueries
Represents the Queries record for the operation: getOrderEarningsSummary
Fields
- filter? string[] - This parameter can be used to filter orders created within a specified date range. The filter uses the <code>orderCreationDate</code> field, which works similarly to the <code>transactionDate</code> filter used by the Transactions API. Currently, <code>orderCreationDate</code> is the only supported filter value.<p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) and should be adjusted accordingly for the local timezone of the user.</span></p><p><b>Default</b>: If no value is specified, results from the past year will be returned.</p>
ebay.finances: GetPayoutHeaders
Represents the Headers record for the operation: getPayout
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetPayoutSummaryHeaders
Represents the Headers record for the operation: getPayoutSummary
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetPayoutSummaryQueries
Represents the Queries record for the operation: getPayoutSummary
Fields
- filter? string[] - The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect all payouts in all states that have occurred within the last five years:<br><ul><li><b>payoutDate</b>: consider payouts processed within a specific range of dates. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. Below is the proper syntax to use if filtering by a date range: <br><br><code>https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutDate:[2024-12-17T00:00:01.000Z..2024-12-24T00:00:01.000Z]</code><br><br>Only payouts from the last five years can be retrieved, so make sure the starting date is less than five years in the past from the present time. Also, the maximum date range that can be specified through this date filter is 36 months, so make sure your specified date range is no more than 36 months.</li> <li><b>payoutStatus</b>: consider only the payouts in a particular state. Only one payout state can be specified with this filter. For supported <b>payoutStatus</b> values, see <a href="/develop/api/sell/finances_api#sell-finances_api-payout-getpayouts.payoutstatusenum">PayoutStatusEnum</a>.<br><br>Below is the proper syntax to use if filtering by payout status: <br><br><code>https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutStatus:{SUCCEEDED}</code></ul><br>If both the <b>payoutDate</b> and <b>payoutStatus</b> filters are used, only the payouts that satisfy both criteria are considered in the results
ebay.finances: GetSellerFundsSummaryHeaders
Represents the Headers record for the operation: getSellerFundsSummary
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetTransactionSummaryHeaders
Represents the Headers record for the operation: getTransactionSummary
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: GetTransactionSummaryQueries
Represents the Queries record for the operation: getTransactionSummary
Fields
- filter string[] - Numerous filters are available for the <strong>getTransactionSummary</strong> method, and these filters are discussed below. One or more of these filter types can be used. The <b>transactionStatus</b> filter must be used. All other filters are optional. <ul><li><b>transactionStatus</b>: the data returned in the response pertains to the sales, payouts, and transfer status set. For supported <b>transactionStatus</b> values, see <a href="/api-docs/sell/finances/types/pay:TransactionStatusEnum" target="_blank ">TransactionStatusEnum</a>. <br><br>Below is the proper syntax to use when setting up the <b>transactionStatus</b> filter: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}</code></li><li><b>transactionDate</b>: only consider monetary transactions that occurred within a specific range of dates.<br><br><span class="tablenote"><strong>Note:</strong> All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) and should be adjusted accordingly for the local timezone of the user.</span><br><br>Below is the proper syntax to use if filtering by a date range: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]</code><br><br><b>Note:</b>Only monetary transactions from the last five years can be retrieved, so make sure the starting date is less than five years in the past from the present time. Also, the maximum date range that can be specified through this date filter is 36 months, so make sure your specified date range is no more than 36 months.</li> <li><b>transactionType</b>: only consider a specific type of monetary transaction. For supported <b>transactionType</b> values, see <a href="/api-docs/sell/finances/types/pay:TransactionTypeEnum" target="_blank ">TransactionTypeEnum</a>.<br><br>Below is the proper syntax to use if filtering by a monetary transaction type: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}</code></li><li><b>buyerUsername</b>: only consider monetary transactions involving a specific buyer (specified with the buyer's eBay username or user ID). Below is the proper syntax to use if filtering by a specific eBay buyer: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}</code> </li><li><b>payoutId</b>: 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: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{58}</code> </li><li><b>transactionId</b>: the unique identifier of a monetary transaction. For a sales order, the <b>orderId</b> filter should be used instead. Only the monetary transaction(s) associated with this <b>transactionId</b> value are returned.<br><br><span class="tablenote"><strong>Note:</strong> This filter cannot be used alone; the <b>transactionType</b> must also be specified when filtering by transaction ID.</span><br><br>Below is the proper syntax to use if filtering by a specific transaction ID: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-00-33}&filter=transactionType:{SALE}</code> </li><li><b>orderId</b>: the unique identifier of a sales order. For any other monetary transaction, the <b>transactionId</b> filter should be used instead. Only the monetary transaction(s) associated with this <b>orderId</b> value are returned. Below is the proper syntax to use if filtering by a specific order ID: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-00-3**3}</code> </li></ul>
ebay.finances: GetTransferHeaders
Represents the Headers record for the operation: getTransfer
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: ListBillingActivitiesHeaders
Represents the Headers record for the operation: listBillingActivities
Fields
- acceptLanguage? string - This header indicates the natural language and locale preferred by the user for the response.<br><br>For more information, see the <b>Accept-Language</b> header in <a href="/develop/api/sell/request_headers" target="_blank ">Request Headers</a> and <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank">Marketplace ID values</a>. If not provided, defaults to <code>en-US</code>
ebay.finances: ListBillingActivitiesQueries
Represents the Queries record for the operation: listBillingActivities
Fields
- filter? string - This required field specifies which results to return in the response. Only one of the following four filter values must be used. A user can either retrieve all billing activity within a date range, or they can retrieve billing activity related to a specific eBay order, eBay listing, or they can retrieve information on a specific billing activity.<br /><ul><li><b>activityId</b>: If this filter is used, only information on a specific billing activity is returned. The <a href="/develop/api/sell/finances_api#sell-finances_api-billing_activity-getbillingactivities.billingactivitylineitem.billingtransactionid">billingTransactionId</a> returned in the response can be used as the <b>activityId</b>.</li><li><b>listingId</b>: If this filter is used, only billing activity associated with the specified listing is returned.</li><li><b>orderId</b>: If this filter is used, only billing activity associated with the specified order is returned.</li><li><b>transactionDate</b>: If a date range filter is used, only billing activity that occurred within the specified date range is returned. The starting date cannot be set back further than 120 days in the past. Use UTC date values in the following order: <code>[<em>start</em>..<em>end</em>]</code></li></ul><br /><b>Examples</b><br /><br />IDs:<br /> <code>filter=activityID:{12**56}</code><br /><br />Date range:<br /> <code>filter=transactionDate:[2025-10-01T00:00:00Z..2025-10-31T23:59:59Z]</code>
- offset? string - Specifies the number of records to skip in the result set. This is used with the <code>limit</code> field to control the pagination of the output. For example:<br><ul><li>If <b>offset</b> is <code>0</code> and <b>limit</b> is <code>10</code>, the method will retrieve records 1-10 from the list of records returned</li><li>If <b>offset</b> is <code>10</code> and <b>limit</b> is <code>10</code>, the method will retrieve records 11-20 from the list of records returned.</li></ul><p>If this parameter is not set, its value defaults to <code>0</code> which returns the first page of records.</p><p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>This feature employs a zero-based list, where the first activity in the list has an offset of 0.</span></p><p><b>Default:</b> <code>0</code> (zero, returns the first page)</p>
- 'limit? string - Sets the maximum number of records to return per page of data.<br><p>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, with offset set to <code>20</code> and limit set to <code>10</code>, the call retrieves entries 21 through 30 from the result set.</p><p>Although this field is optional, if omitted the default value of <code>100</code> is used.</p><br> <b>Minimum:</b> <code>1</code><br><b>Maximum:</b> <code>200</code><br><b>Default:</b> <code>100</code>
- sort? string - By default, transactions that match the input criteria are sorted in descending order according to the transaction date (most recent transactions returned first).<br><br>To view transactions in ascending order instead (oldest transactions first), include the <b>sort</b> query parameter and set its value to <code>sort=transactionDate</code>. For example (ascending order):<br><br><code>filter=transactionDate:[2025-11-01T00:00:01.000Z..2025-11-12T00:00:01.000Z]&sort=transactionDate</code><br><br>Transactions can only be sorted according to transaction date. If omitted, defaults to descending order (most recent transactions returned first)
ebay.finances: ListOrderEarningsHeaders
Represents the Headers record for the operation: listOrderEarnings
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: ListOrderEarningsQueries
Represents the Queries record for the operation: listOrderEarnings
Fields
- filter? string[] - This parameter can be used to filter orders created within a specified date range. The filter uses the <code>orderCreationDate</code> field, which works similarly to the <code>transactionDate</code> filter used by the Transactions API. Currently, <code>orderCreationDate</code> is the only supported filter value. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) and should be adjusted accordingly for the local timezone of the user.</span></p><p><b>Default</b>: If no value is specified, results from the past year will be returned.</p>
- offset? int - This parameter can be used to specify the number of records to skip before returning results. This parameter is commonly used with the <code>limit</code> parameter to retrieve the next page of results.<br><br><b>Maximum:</b> 10,000<br><b>Default:</b> 0
- 'limit? int - This parameter configures the number of orders to return per page of the result set. Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. <br><br> For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the method retrieves orders 11 thru 20 from the result set. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first page in the results set has an offset value of <code>0</code>. </span><br> <b>Maximum:</b> <code>200</code> <br> <b>Default:</b> <code>20</code>
- sort? string[] - Sort order for a collection of resources. Available value: orderCreationDate For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/sqa:SortField
ebay.finances: ListPayoutsHeaders
Represents the Headers record for the operation: listPayouts
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: ListPayoutsQueries
Represents the Queries record for the operation: listPayouts
Fields
- filter? string[] - The filter types that can be used here are discussed below. If none of these filters are used, all payouts in all states from within the last five years are returned:<br><ul><li><b>payoutDate</b>: search for payouts within a specific range of dates. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. Below is the proper syntax to use if filtering by a date range: <br><br><code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2024-12-17T00:00:01.000Z..2024-12-24T00:00:01.000Z]</code><br><br>Only payouts from the last five years can be retrieved, so make sure the starting date is less than five years in the past from the present time. Also, the maximum date range that can be specified through this date filter is 36 months, so make sure your specified date range is no more than 36 months.</li><li><b>lastAttemptedPayoutDate</b>: search for attempted payouts that failed within a specific range of dates. In order to use this filter, the <b>payoutStatus</b> filter must also be used and its value must be set to <code>RETRYABLE_FAILED</code>. The date format to use is <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. The same syntax and requirements applicable to the <b>payoutDate</b> filter also apply to the <b>lastAttemptedPayoutDate</b> filter. <br><br>This filter is only applicable (and will return results) if one or more seller payouts have failed, but are retryable.</li> <li><b>payoutStatus</b>: search for payouts in a particular state. Only one payout state can be specified with this filter. For supported <b>payoutStatus</b> values, see <a href="/develop/api/sell/finances_api#sell-finances_api-payout-getpayouts.payoutstatusenum">PayoutStatusEnum</a>.<br><br>Below is the proper syntax to use if filtering by payout status: <br><br><code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutStatus:{SUCCEEDED}</code></li><li><b>payoutReference</b>: returns the two true (actual) payouts associated with the payoutReference id. This parameter can support up to 200 <b>payoutReference</b> inputs. This filter is <b>only</b> supported for mainland China sellers. Below is the proper syntax to use if filtering by a specific <b>payoutReference</b>:<br><br><code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutReference:{5********3}</code></li></ul><br>If both the <b>payoutDate</b> and <b>payoutStatus</b> filters are used, payouts must satisfy both criteria to be returned
- offset? int - This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the <strong>offset</strong> value in the request to <code>10</code>. <br><br>In the request, you can use the <b>offset</b> parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>30</code> and <b>limit</b> is set to <code>10</code>, the method retrieves payouts 31 thru 40 from the resulting collection of payouts.<br><br>To avoid poor response time, use <b>offset</b> values of less than <code>5000</code>.<br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first payout in the results set has an offset value of <code>0</code>.</span><br><br><b>Default:</b> <code>0</code> (zero)
- 'limit? int - The number of payouts to return per page of the result set. Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. <br><br> For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the method retrieves payouts 11 thru 20 from the result set. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first payout in the results set has an offset value of <code>0</code>. </span> <br><br> <b>Maximum:</b> <code>200</code> <br> <b>Default:</b> <code>20</code>
- sort? string[] - By default, payouts or failed payouts that match the input criteria are sorted in descending order according to the payout date/last attempted payout date (i.e., most recent payouts returned first).<br><br>To view payouts in ascending order instead (i.e., oldest payouts/attempted payouts first,) you would include the <b>sort</b> query parameter, and then set the value of its <b>field</b> parameter to <code>payoutDate</code> or <code>lastAttemptedPayoutDate</code> (if searching for failed, retryable payouts). Below is the proper syntax to use if filtering by a payout date range in ascending order:<br><br><code>https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]&sort=payoutDate</code><br><br>Payouts can only be sorted according to payout date, and can not be sorted by payout status
ebay.finances: ListTransactionsHeaders
Represents the Headers record for the operation: listTransactions
Fields
- xEBAYCMARKETPLACEID MarketplaceIdEnum - This header identifies the seller's eBay marketplace.<br><br>See <a href="/develop/api/sell/request_headers#marketplace-id-values" target="_blank ">Request Headers</a> for the marketplace ID values.<br><br><span class="tablenote"><b>Note:</b> If a marketplace ID value is not provided, the default value of <code>EBAY_US</code> is used.</span>
ebay.finances: ListTransactionsQueries
Represents the Queries record for the operation: listTransactions
Fields
- filter? string[] - Numerous filters are available for the <strong>getTransactions</strong> method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all monetary transactions occurring within the last five years are returned:<ul><li><b>transactionDate</b>: search for monetary transactions that occurred within a specific range of dates.<br><br><span class="tablenote"><strong>Note:</strong> All dates must be input using UTC format (<code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>) and should be adjusted accordingly for the local timezone of the user.</span><br>Below is the proper syntax to use if filtering by a date range: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]</code><br><br>Only payouts from the last five years can be retrieved, so make sure the starting date is less than five years in the past from the present time. Also, the maximum date range that can be specified through this date filter is 36 months, so make sure your specified date range is no more than 36 months.</li> <li><b>transactionType</b>: search for a specific type of monetary transaction. For supported <b>transactionType</b> values, see <a href="/develop/api/sell/finances_api#sell-finances_api-transaction-gettransactions.transactiontypeenum">TransactionTypeEnum</a>.<br><br>Below is the proper syntax to use if filtering by a monetary transaction type: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}</code></li><li><b>transactionStatus</b>: this filter type is only applicable for sales orders, and allows the user to filter seller payouts in a particular state. For supported <b>transactionStatus</b> values, see <a href="/develop/api/sell/finances_api#sell-finances_api-transaction-gettransactions.transactionstatusenum">TransactionStatusEnum</a>.<br><br>Below is the proper syntax to use if filtering by transaction status: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}</code></li><li><b>buyerUsername</b>: the eBay username or 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: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}</code> </li><li><b>payoutId</b>: 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: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{58}</code> </li><li><b>transactionId</b>: use this field <b>transactionId</b> and also <b>transactionType</b> to filter for a unique identifier of a monetary transaction, or an error will occur. For a sales order, the <b>orderId</b> filter should be used instead. Only the monetary transaction defined by the identifier is returned.<br><br><span class="tablenote"><strong>Note:</strong> This filter cannot be used alone; the <b>transactionType</b> must also be specified when filtering by transaction ID.</span><br>Below is the proper syntax to use if filtering by a specific transaction ID: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-00-33}&filter=transactionType:{SALE}</code> </li><li><b>orderId</b>: the unique identifier of a sales order. Only monetary transaction(s) associated with this <b>orderId</b> value are returned.<br><br>For any other monetary transaction, the <b>transactionId</b> filter should be used instead.<br><br>Below is the proper syntax to use if filtering by a specific order ID:<br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-00-3**3}</code> </li><li><b>payoutReference</b>: returns the monetary transactions associated with the <b>payoutReference</b>. By using this ID as a filter parameter, the user will be able to track all monetary transactions associated with both sibling payouts, including sales and refunds, if any. This filter is <b>only</b> supported for sellers in Mainland China. Below is the proper syntax to use if filtering by <b>payoutReference</b>: <br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutReference:{5*******3}</code></li></ul>
- offset? int - 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 <strong>offset</strong> value in the request to <code>10</code>. <br><br>In the request, you can use the <b>offset</b> parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>30</code> and <b>limit</b> is set to <code>10</code>, the method retrieves transactions 31 thru 40 from the resulting collection of transactions. <br><br> To avoid poor response time, use <b>offset</b> values of less than <code>5000</code>. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br><b>Default:</b> <code>0</code> (zero)
- 'limit? int - The number of monetary transactions to return per page of the result set. Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. <br><br> For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the method retrieves monetary transactions 11 thru 20 from the result set. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span> <br><br> <b>Maximum:</b><code> 1000</code> <br> <b>Default:</b><code> 20</code>
- sort? string[] - By default, monetary transactions that match the input criteria are sorted in descending order according to the transaction date (i.e, most recent transactions returned first).<br><br>To view transactions in ascending order instead (i.e., oldest transactions first), you would include the <b>sort</b> query parameter and set its value to <code>transactionDate</code>. Below is the proper syntax to use if filtering by a transaction date range in ascending order:<br><br><code>https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2023-10-01T00:00:01.000Z..2023-10-12T00:00:01.000Z]&sort=transactionDate</code><br><br>Transactions can only be sorted according to transaction date
ebay.finances: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Refresh URL
ebay.finances: OrderEarning
This type defines the earnings details for a single order. It includes information associated with the order, such as an informatiuon about the buyer, an order summary, and an order earnings summary
Fields
- orderId? string - The unique identifier of the order
- orderEarningsSummary EarningsSummary - This type defines a summarized view of earnings information derived from one order. It defines fields that provides a summarized view of earnings information derived from one order including aggregated financial values for gross amount, expenses, earnings, and refunds.
- orderLastModifiedDate? string - The date when the order was last modified
- orderSummary? OrderSummary - This type provides order cost details, including line item subtotal, shipping and handling, seller-collected taxes, and any seller applied discounts. Always provided in the listing currency
- orderCreationDate string - The date the order was created and payment was successful
- buyer? BuyerWithId - This type defines identifying information about the buyer associated with an order
ebay.finances: OrderEarningFee
This type is used to show the fee type and amount of the marketplace fee or donation
Fields
- amount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- feeType? FeeTypeEnum - This enumerated type shows the fees that are automatically deducted from seller payouts. | - BELOW_STANDARD_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the order line item cost. - BELOW_STANDARD_SHIPPING_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the shipping cost for an order line item.<br><br><b>Note</b>: This fee is bundled with the <code>BELOW_STANDARD_FEE</code> and not returned separately. - FINAL_VALUE_FEE_FIXED_PER_ORDER: This fee is a fixed-cost fee charged by eBay for every order (regardless of how many line items are in the order). This fee can vary by country. - FINAL_VALUE_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the order line item cost. The percentage varies by eBay category. - INTERNATIONAL_FEE: This fee is an international fee associated with an order line item if the seller's eBay registered address country is different than the buyer's registered address or delivery address. This fee is calculated as a percentage of the total amount of the order line item. - HIGH_ITEM_NOT_AS_DESCRIBED_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the order line item cost. - HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the shipping cost for the order line item.<br><br><b>Note</b>: This fee is bundled with the <code>HIGH_ITEM_NOT_AS_DESCRIBED_FEE</code> and not returned separately. - PAYMENT_PROCESSING_FEE: This is a payment processing fee charged for each order.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE_FIXED_PER_ORDER</code> and not returned separately. - FINAL_VALUE_SHIPPING_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the shipping cost for the order line item. The percentage varies by eBay category.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE</code> and not returned separately. - INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee for a listing. - BOLD_FEE: This enumeration value indicates that the account entry is a listing upgrade fee or credit for a listing title in boldface font. - FINANCE_FEE: This enumeration value indicates that the account entry is a finance charge to the user's account. - CATEGORY_FEATURED_FEE: This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.<br><br><b>Note</b>: This feature is no longer available to most marketplaces and sellers. - NSFCHECK_FEE: This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear due to insufficient funds. - PROMOTIONAL_CREDIT: This enumeration value indicates that the account entry is a promotional credit issued by eBay. - GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Picture Gallery. - FEATURED_GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Featured section at the top of the Picture Gallery page. - RESERVE_PRICE_FEE: This enumeration value indicates that the account entry is a fee charged or a credit refunded to the seller for a reserve price that was set for an auction listing. - IPIXPHOTO_FEE: This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace. - LARGE_PICTURE_FEE: This enumeration value indicates that the account entry is a fee charged by eBay for a super-sized picture in a listing. - EBAY_STORE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged or a credit issued toward the user's eBay Store. - BUY_IT_NOW_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued by eBay if the seller uses the 'Buy It Now' feature on an auction listing. - SUBTITLE_FEE: This enumeration value indicates the account entry is a fee charged to the seller for adding a subtitle to a listing or a credit issued from eBay. - INTERNATIONAL_LISTING_FEE: This enumeration value indicates that the account entry is a 'cross-border trade' fee or credit. - PRO_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Pro Pack Bundle feature pack. - MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a fee or a credit toward a fee for a Terapeak Research pro subscription. - VEHICLE_LOCAL_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee or a credit toward a monthly subscription fee charged for a National Vehicle subscription. - VEHICLE_LOCAL_INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee or a credit for a Motors local listing. - VALUE_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged or a credit towards the fee charged by eBay to the seller for using the Value Pack Bundle feature pack. - PRO_PACK_PLUS_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack. - GALLERY_PLUS_FEE: This enumeration value indicates that the account entry is a fee charged or a credit towards a fee charged by eBay for listing an item with the Gallery Plus feature. - EBAY_MOTORS_PRO_FEE: This enumeration value indicates that the account entry is an eBay Motors Pro fee or a credit towards an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only. - PRIVATE_LISTING_FEE: This enumeration value indicates that the account entry is a fee for a private listing or a credit towards a fee charged. - AUCTION_END_EARLY_FEE: This enumeration value indicates that the account entry is a fee charged to the seller's account if the seller ends an auction (with bids) early. - STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE: This enumeration value indicates that the account entry is a fee charged or a credit toward a fee charged for early termination of an eBay Stores subscription. - AD_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued for an Ad on eBay. - EBAY_PLUS_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is an annual subscription fee charged a credit toward an annual subscription fee for an eBay Plus subscription. - VEHICLE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged a credit toward a monthly subscription fee for a National Vehicle subscription. - CO_FUNDING_COUPON_FEE: This enumeration value indicates that eBay is billing the seller or giving credit to the seller for a co-funding charge. - PAYMENT_DISPUTE_FEE: This enumeration value indicates the credit is a charge or a seller reimbursement for an eBay payment dispute fee. - PREMIUM_AD_FEES: This enumeration value indicates the invoice charged or the credit issued was for a Premium Ad Fee. - VEHICLES_BASIC_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Basic Package fee. - VEHICLES_PLUS_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Plus Package fee. - VEHICLES_PREMIUM_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Premium Package fee. - DEPOSIT_PROCESSING_FEE: This fee is charged to a seller when they sell a motor vehicle and require a deposit from the buyer. - EXPRESS_PAYOUT_FEE: This is the fee charged by eBay when a seller requests a payout through a debit card.<br><br><b>Note</b>: If the requested payout to a debit card fails, the <code>EXPRESS_PAYOUT_FEE</code> will be credited back to the seller's account. - TAX_DEDUCTION_AT_SOURCE: This enumeration value indicates the account entry is the tax amount automatically deducted from a seller's payout. - INCOME_TAX_WITHHOLDING: This enumeration value indicates the account entry is the required income tax amount deducted from a seller's payout. - VAT_WITHHOLDING: This enumeration value indicates that the account entry is the required VAT amount deducted from the seller's payout. - BANK_PAYOUT_FEE: This enumeration value indicates that a fee is charged by eBay when a seller requests a payout through a bank account.<br><br><b>Note</b>: <code>BANK_PAYOUT_FEE</code> is only applicable for CNY sellers and when the <b>payoutInstrumentType</b> is <code>BANK</code>. - CHARITY_DONATION: This enumeration value indicates the charitable donations against a sale. - REGULATORY_OPERATING_FEE: This enumeration value indicates that a fee is charged by eBay to cover the costs associated with complying with regulatory requirements in specific marketplaces. - OTHER_FEES: This enumeration value may be returned if the fee type cannot be determined, or has not been classified
ebay.finances: OrderEarnings
The base response type of the getOrderEarnings method, which includes pagination output fields and a collection of orders that match the request criteria
Fields
- next? string - The URI for the next page of results. This field is only returned if there is a next page of results to retrieve
- total? int - The total number of order earnings records that match the request criteria
- offset? int - The number of order earnings records skipped before returning the current page of results
- prev? string - The URI for the previous page of results. This field is only returned if there is a previous page of results to retrieve
- 'limit int - The maximum number of order earnings records returned in a single page of results
- orders? OrderEarning[] - The list of order earnings records returned in the current page of results. This array will be returned as empty if no orders match the request criteria
- href string - The URI for the current page of results
ebay.finances: OrderEarningsSummary
The base response type for the getOrderEarningsSummary method, which includes aggregate order earnings, expenses, gross amount, and order count for orders created within the date range and included in the summary
Fields
- orderCount? int - The total number of orders included in the summary
- grossAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- orderEarnings? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- expenses? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- refunds? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: OrderLineItem
This type is used to show the fees and donations that are deducted from a seller payout for each line item in an order
Fields
- donations? Fee[] - The list of donations applied to the line item.<br><br><span class="tablenote"><b>Note: </b>Currently, this array is only returned if the seller chooses to donate a percentage of the sales proceeds to a charitable organization registered with the eBay for Charity program.</span>
- marketplaceFees? Fee[] - An array of all fees accrued for the order line item and deducted from a seller payout
- feeBasisAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- lineItemId? string - The unique identifier of an order line item
ebay.finances: OrderSummary
This type provides order cost details, including line item subtotal, shipping and handling, seller-collected taxes, and any seller applied discounts. Always provided in the listing currency
Fields
- itemSubtotal? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- sellerCollectedTaxes? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- discounts? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- shippingAndHandlingCosts? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: Payout
This type is used to express the details of one seller payout that is returned with the getPayout or getPayouts methods
Fields
- amount Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- payoutInstrument PayoutInstrument - This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts
- payoutStatusDescription string - This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the <strong>payoutStatus</strong> field. The following shows what description text might appear based on the different <strong>payoutStatus</strong> values:<ul><li><code>INITIATED</code>: <em>Preparing to send</em></li><li><code>SUCCEEDED</code>: <em>Funds sent</em></li><li><code>REVERSED</code>: <em>Waiting to retry : Money rejected by seller's bank</em></li><li><code>RETRYABLE_FAILED</code>: <em>Waiting to retry</em></li><li><code>TERMINAL_FAILED</code>: <em>Payout failed</em></li></ul>
- payoutStatus PayoutStatusEnum - This enumeration type lists the different possible states of an eBay payout to a seller's account. | - INITIATED: This enumeration value indicates that a payout was initiated. - SUCCEEDED: This enumeration value indicates a successful payout. - REVERSED: This enumeration value indicates that the payout was reversed. - RETRYABLE_FAILED: This enumeration value indicates that a payout failed, but eBay will try to process it again. - TERMINAL_FAILED: This enumeration value indicates that a payout failed, and it will not be tried again
- payoutId string - The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account
- payoutDate string - This timestamp indicates when the seller payout began processing. The following format is used: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. For example, <code>2015-08-04T19:09:02.768Z</code>. This field is still returned even if the payout was pending but failed (<strong>payoutStatus</strong> value shows <code>RETRYABLE_FAILED</code> or <code>TERMINAL_FAILED</code>)
- totalAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- bankReference? string - This field contains additional information provided by the bank and passed on by the payment processor; e.g., the manner in which the transaction will appear on the seller's bank statement. The field is returned only when provided by the bank and processor
- payoutReference? string - This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout ID(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account. <br><br><span class="tablenote"><b>Note: </b>Split-payout functionality will <b>only</b> be available to mainland China sellers.</span>
- totalFee? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- lastAttemptedPayoutDate? string - This timestamp indicates the date/time when eBay last attempted to process a seller payout but it failed. This field is only returned if a seller payout fails, and the <strong>payoutStatus</strong> value shows <code>RETRYABLE_FAILED</code> or <code>TERMINAL_FAILED</code>. A seller can filter on the <b>lastAttemptedPayoutDate</b> in a <b>getPayouts</b> request
- transactionCount int - This integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least <code>1</code>, since there is at least one order per seller payout.<br/><br/>For split payouts, each of the two sibling payouts would be considered its own transaction. Because of this, if a seller had a payout for one order, but split the order between two accounts, the value would be <code>2</code> instead of <code>1</code>.<br><br><span class="tablenote"><b>Note: </b>Split-payout functionality is <b>only</b> applicable to mainland China sellers. </span>
- totalFeeDetails? Fee[] - This array indicates all payout fees associated with a payout, including the fee type, amount, value, and currency
- payoutMemo? string - This field contains information provided by upstream components, based on internal and external commitments. A typical message would contain the expected arrival time of the payout
ebay.finances: PayoutDetails
This type provide payout details for a split-payout case. This type is only applicable for split payouts
Fields
- payoutReference? string - This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout ID(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account. This value can be used by the <b>filter</b> query parameter of the <b>getPayouts</b> method to get the monetary details of each true(actual) payout associated with the payoutReference. <br><br><span class="tablenote"><b>Note:</b>Split-payout functionality will <b>only</b> be available to mainland China sellers.</span>
- payoutIds? string[] - This array indicates the list of true(actual) payout ids associated with a split payout. These values can be used as a path parameter for the <b>getPayout</b> method to retrieve details on the associated payouts
ebay.finances: PayoutInstrument
This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts
Fields
- instrumentType string - This value indicates the type of account that received the payout. The value returned in this field may be:<br><ul><li><code>BANK</code>: indicates that the payout was made to a seller's bank account.</li><li><code>CARD</code>: indicates that the payout went to a seller's debit card</li><li>The name of a digital wallet provider or payment processor (e.g., <code>PAYONEER</code>)</li></ul><span class="tablenote"><b>Note:</b> Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China.</span>
- accountLastFourDigits string - This value is the last four digits of the account that the seller uses to receive the payout. This may be the last four digits of a bank account, a debit card, or a payment processor account such as Payoneer
- nickname string - When <b>instrumentType</b> returns <code>BANK</code>, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.<br><br>When <b>instrumentType</b> returns <code>CARD</code>, this value is the debit card network for the debit card that receives the payout.<br><br>When <b>instrumentType</b> returns a provider of digital wallet or payment processing services, the value returned is the name of the service provider (e.g., <code>PAYONEER</code>).<br><br><span class="tablenote"><b>Note:</b> Card payouts are not currently available for sellers in mainland China.</span>
- payoutPercentage? string - This value indicates the current payout percentage allocated to a payout instrument. For example, <code>50</code> indicates that 50% of the payout goes to the instrument.<br><br>This field will be returned even when 100% of the payout funds are going to one payout instrument.<br><br>This field is only returned to sellers in mainland China
ebay.finances: Payouts
This type is the base response type of the getPayouts method, and contains an array of one or more payouts (that match the input criteria), the total count of payouts in the response, and various pagination data for the results set
Fields
- next? string - The <b>getPayouts</b> call URI to use if you wish to view the next page of the result set. <br><br>This field is only returned if there is a next page of results to view based on the current input criteria
- payouts Payout[] - An array of one or more payouts that match the input criteria. Details for each payout include the unique identifier of the payout, the status of the payout, the amount of the payout, and the number of monetary transactions associated with the payout
- total int - This integer value is the total number of payouts in the results set based on the current input criteria. Based on the total number of payouts that match the criteria, and on the <strong>limit</strong> and <strong>offset</strong> values, there may be additional pages in the results set
- offset int - This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the <strong>offset</strong> value in the request to <code>10</code>. <br><br>In the request, you can use the <b>offset</b> parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>30</code> and <b>limit</b> is set to <code>10</code>, the call retrieves payouts 31 thru 40 from the resulting collection of payouts. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br><br><b>Default:</b> <code>0</code> (zero)
- prev? string - The <b>getPayouts</b> call URI to use if you wish to view the previous page of the result set. <br><br>This field is only returned if there is a previous page of results to view based on the current input criteria
- 'limit int - The maximum number of payouts that may be returned per page of the result set. The <strong>limit</strong> value can be passed in as a query parameter, or if omitted, its value defaults to <code>20</code>. <br><br><span class="tablenote"><strong>Note:</strong> If this is the last or only page of the result set, the page may contain fewer payouts than the <strong>limit</strong> value. To determine the number of pages in a result set, divide the <b>total</b> value (total number of payouts matching input criteria) by this <strong>limit</strong> value, and then round up to the next integer. For example, if the <b>total</b> value was <code>120</code> (120 total payouts) and the <strong>limit</strong> value was <code>50</code> (show 50 payouts per page), the total number of pages in the result set is three, so the seller would have to make three separate <strong>getPayouts</strong> calls to view all payouts matching the input criteria. </span><br><br><b>Maximum:</b> <code>200</code> <br> <b>Default:</b> <code>20</code>
- href string - The URI of the <b>getPayouts</b> call request that produced the current page of the result set
ebay.finances: PayoutSummaryResponse
This type is the base response type of the getPayoutSummary method, and contains the total count of seller payouts (that match the input criteria), the total count of monetary transactions (order payment, buyer refunds, or seller credits) associated with those payouts, and the total value of those seller payouts
Fields
- amount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- payoutCount int - This integer value indicates the total count of payouts to the seller that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show <code>0</code>)
- transactionCount int - This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show <code>0</code>). If there is at least one payout that matches the input criteria, the value in this field will be at least <code>1</code>
ebay.finances: Reference
This field is returned for NON_SALE_CHARGE transactions that contain non-transactional seller fees
Fields
- referenceType? ReferenceTypeEnum - An enumerated type that identifies the type of reference ID provided. | - CANCELLATION_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a cancellation. - CASE_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a case. - INVOICE: This enumeration value indicates that the ID provided refers to the unique identifier of an invoice. It indicates that the seller will be billed by invoice, and fees will not be deducted from the payout.<br><br><b>Note</b>: This enumeration value applies only to <code>NON_SALE_CHARGE transactions</code>. - ITEM_ID: This enumeration value indicates that the ID provided refers to the unique identifier of an item. It is used to identify listing-related fees.<br><br><b>Note</b>: This enumeration value applies only to NON_SALE_CHARGE transactions. - ORDER_ID: This enumeration value indicates that the ID provided refers to the unique identifier of an order.<br><br><b>Note</b>: This enumeration value applies only to sales/transactions-related fees. - 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. - LOAN_REPAYMENT_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a repayment transaction.<br><br><b>Note</b>: This is an externally assigned reference ID. It cannot be used to filter transactions. - RETURN_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a return. - PAYOUT_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a payout. - PSNAD_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a Partial Significantly Not as Described (PSNAD) claim filed against an order
- referenceId? string - The identifier of the transaction as specified by the <strong>referenceType</strong>. For example, with a <strong>referenceType</strong> of <strong>item_id</strong>, the <strong>referenceId</strong> refers to a unique item. This item may have several <code>NON_SALE_CHARGE</code> transactions
ebay.finances: SellerFundsSummaryResponse
This type is used by the response payload of the getSellerFundsSummary method. All of the funds returned in getSellerFundsSummary are funds that have not yet been paid to the seller through a seller payout. If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content is returned instead
Fields
- availableFunds Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- processingFunds Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- fundsOnHold Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- totalFunds? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: Tax
This type defines tax information associated with a transaction
Fields
- amount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- taxType? TaxTypeEnum - This enumerated type lists the type of taxes that can be charged against monetary transactions. | - VAT: VAT is Value-Added Tax.
ebay.finances: Transaction
This type is used to express the details of one of the following monetary transactions: a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account
Fields
- amount Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- references? Reference[] - This field contains reference information for the transaction fee. This includes an ID and the type of ID provided (such as item ID)
- orderId? string - The unique identifier of the eBay order associated with the monetary transaction
- transactionStatus TransactionStatusEnum - This enumeration type lists the different possible states of a monetary transaction, including payouts to sellers, refunds to buyers, and credits to a seller's account. <p> <span class="tablenote"><b>Note:</b> The enumerations <strong>COMPLETED</strong> and <strong>FAILED </strong> apply to monetary transactions with the <strong>transactionType</strong> of <code>TRANSFER</code>. They only apply to monetary transactions where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.</span></p> | - FUNDS_ON_HOLD: This enumeration value indicates that the funds for the monetary transaction are currently being held. - FUNDS_PROCESSING: This enumeration value indicates that the monetary transaction is being processed. - FUNDS_AVAILABLE_FOR_PAYOUT: This enumeration value indicates that the corresponding transaction is available for a seller payout. - PAYOUT: This enumeration value indicates that the corresponding transaction has been paid out to the seller's account. - COMPLETED: This enumeration value indicates that the corresponding transaction has completed and funds have been transferred to eBay. No additional action is required. See <b>Note</b>. - FAILED: This enumeration value indicates that the corresponding transaction failed and funds have not been transferred to eBay. This does not indicate release of seller's responsibilities for required reimbursement. See <b>Note</b>.
- salesRecordReference string - 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.<br><br><span class="tablenote"><strong>Note:</strong> For all orders originating after February 1, 2020, a value of <code>0</code> will be returned in this field. The Sales Record Number field has also been removed from Seller Hub. Instead of <strong>salesRecordReference</strong>, depend on <strong>orderId</strong> instead as the identifier of the order. The <strong>salesRecordReference</strong> field has been scheduled for deprecation, and a date for when this field will no longer be returned at all will be announced soon.</span>
- taxes? Tax[] - This array shows the tax type and amount applicable to the transaction. <br><br><span class="tablenote"><b>Note:</b> Currently, this array is only returned for tax charged against a purchased eBay shipping label.</span>
- totalFeeAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- totalFeeBasisAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- eBayCollectedTaxAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- feeType? FeeTypeEnum - This enumerated type shows the fees that are automatically deducted from seller payouts. | - BELOW_STANDARD_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the order line item cost. - BELOW_STANDARD_SHIPPING_FEE: This fee is charged to Below Standard sellers in addition to the <code>FINAL_VALUE_FEE</code>, and is based on a percentage of the shipping cost for an order line item.<br><br><b>Note</b>: This fee is bundled with the <code>BELOW_STANDARD_FEE</code> and not returned separately. - FINAL_VALUE_FEE_FIXED_PER_ORDER: This fee is a fixed-cost fee charged by eBay for every order (regardless of how many line items are in the order). This fee can vary by country. - FINAL_VALUE_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the order line item cost. The percentage varies by eBay category. - INTERNATIONAL_FEE: This fee is an international fee associated with an order line item if the seller's eBay registered address country is different than the buyer's registered address or delivery address. This fee is calculated as a percentage of the total amount of the order line item. - HIGH_ITEM_NOT_AS_DESCRIBED_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the order line item cost. - HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the shipping cost for the order line item.<br><br><b>Note</b>: This fee is bundled with the <code>HIGH_ITEM_NOT_AS_DESCRIBED_FEE</code> and not returned separately. - PAYMENT_PROCESSING_FEE: This is a payment processing fee charged for each order.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE_FIXED_PER_ORDER</code> and not returned separately. - FINAL_VALUE_SHIPPING_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the shipping cost for the order line item. The percentage varies by eBay category.<br><br><b>Note</b>: This fee is bundled with the <code>FINAL_VALUE_FEE</code> and not returned separately. - INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee for a listing. - BOLD_FEE: This enumeration value indicates that the account entry is a listing upgrade fee or credit for a listing title in boldface font. - FINANCE_FEE: This enumeration value indicates that the account entry is a finance charge to the user's account. - CATEGORY_FEATURED_FEE: This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.<br><br><b>Note</b>: This feature is no longer available to most marketplaces and sellers. - NSFCHECK_FEE: This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear due to insufficient funds. - PROMOTIONAL_CREDIT: This enumeration value indicates that the account entry is a promotional credit issued by eBay. - GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Picture Gallery. - FEATURED_GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Featured section at the top of the Picture Gallery page. - RESERVE_PRICE_FEE: This enumeration value indicates that the account entry is a fee charged or a credit refunded to the seller for a reserve price that was set for an auction listing. - IPIXPHOTO_FEE: This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace. - LARGE_PICTURE_FEE: This enumeration value indicates that the account entry is a fee charged by eBay for a super-sized picture in a listing. - EBAY_STORE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged or a credit issued toward the user's eBay Store. - BUY_IT_NOW_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued by eBay if the seller uses the 'Buy It Now' feature on an auction listing. - SUBTITLE_FEE: This enumeration value indicates the account entry is a fee charged to the seller for adding a subtitle to a listing or a credit issued from eBay. - INTERNATIONAL_LISTING_FEE: This enumeration value indicates that the account entry is a 'cross-border trade' fee or credit. - PRO_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Pro Pack Bundle feature pack. - MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a fee or a credit toward a fee for a Terapeak Research pro subscription. - VEHICLE_LOCAL_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee or a credit toward a monthly subscription fee charged for a National Vehicle subscription. - VEHICLE_LOCAL_INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee or a credit for a Motors local listing. - VALUE_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged or a credit towards the fee charged by eBay to the seller for using the Value Pack Bundle feature pack. - PRO_PACK_PLUS_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack. - GALLERY_PLUS_FEE: This enumeration value indicates that the account entry is a fee charged or a credit towards a fee charged by eBay for listing an item with the Gallery Plus feature. - EBAY_MOTORS_PRO_FEE: This enumeration value indicates that the account entry is an eBay Motors Pro fee or a credit towards an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only. - PRIVATE_LISTING_FEE: This enumeration value indicates that the account entry is a fee for a private listing or a credit towards a fee charged. - AUCTION_END_EARLY_FEE: This enumeration value indicates that the account entry is a fee charged to the seller's account if the seller ends an auction (with bids) early. - STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE: This enumeration value indicates that the account entry is a fee charged or a credit toward a fee charged for early termination of an eBay Stores subscription. - AD_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued for an Ad on eBay. - EBAY_PLUS_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is an annual subscription fee charged a credit toward an annual subscription fee for an eBay Plus subscription. - VEHICLE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged a credit toward a monthly subscription fee for a National Vehicle subscription. - CO_FUNDING_COUPON_FEE: This enumeration value indicates that eBay is billing the seller or giving credit to the seller for a co-funding charge. - PAYMENT_DISPUTE_FEE: This enumeration value indicates the credit is a charge or a seller reimbursement for an eBay payment dispute fee. - PREMIUM_AD_FEES: This enumeration value indicates the invoice charged or the credit issued was for a Premium Ad Fee. - VEHICLES_BASIC_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Basic Package fee. - VEHICLES_PLUS_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Plus Package fee. - VEHICLES_PREMIUM_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Premium Package fee. - DEPOSIT_PROCESSING_FEE: This fee is charged to a seller when they sell a motor vehicle and require a deposit from the buyer. - EXPRESS_PAYOUT_FEE: This is the fee charged by eBay when a seller requests a payout through a debit card.<br><br><b>Note</b>: If the requested payout to a debit card fails, the <code>EXPRESS_PAYOUT_FEE</code> will be credited back to the seller's account. - TAX_DEDUCTION_AT_SOURCE: This enumeration value indicates the account entry is the tax amount automatically deducted from a seller's payout. - INCOME_TAX_WITHHOLDING: This enumeration value indicates the account entry is the required income tax amount deducted from a seller's payout. - VAT_WITHHOLDING: This enumeration value indicates that the account entry is the required VAT amount deducted from the seller's payout. - BANK_PAYOUT_FEE: This enumeration value indicates that a fee is charged by eBay when a seller requests a payout through a bank account.<br><br><b>Note</b>: <code>BANK_PAYOUT_FEE</code> is only applicable for CNY sellers and when the <b>payoutInstrumentType</b> is <code>BANK</code>. - CHARITY_DONATION: This enumeration value indicates the charitable donations against a sale. - REGULATORY_OPERATING_FEE: This enumeration value indicates that a fee is charged by eBay to cover the costs associated with complying with regulatory requirements in specific marketplaces. - OTHER_FEES: This enumeration value may be returned if the fee type cannot be determined, or has not been classified
- payoutId? string - The unique identifier of the seller payout associated with the monetary transaction
- transactionDate string - This timestamp indicates when the monetary transaction (order purchase, buyer refund, seller credit) occurred. The following (UTC) format is used: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. For example, <code>2015-08-04T19:09:02.768Z</code>
- ebayCollectedTaxAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- paymentsEntity? string - This string value indicates the entity that is processing the payment
- transactionId string - This field, when combined with the <a href="#response.transactions.transactionType" >transactionType</a> field, provide a unique identifier of the monetary transaction
- buyer? Buyer - This type is used to express details about the buyer associated with an order. At this time, the only field in this type is the eBay user ID of the buyer, but more fields may get added at a later date
- payoutDetails? PayoutDetails - This type provide payout details for a split-payout case. This type is only applicable for split payouts
- bookingEntry BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- transactionType TransactionTypeEnum - This enumeration type defines the type of monetary transactions retrieved with the <b>getTransactions</b> method. | - SALE: This enumeration value indicates that the monetary transaction type is the sale of an order. - REFUND: This enumeration value indicates that the monetary transaction type is a buyer refund. - CREDIT: This enumeration value indicates that the monetary transaction type is a credit to the seller's account. - DISPUTE: This enumeration value indicates that the monetary transaction type involves a payment dispute between the buyer and seller. - SHIPPING_LABEL: This enumeration value indicates that the monetary transaction type involves eBay billing the seller for the purchase of an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.<br><br><b>Note</b>: eBay shipping label transactions paid through PayPal are not currently supported by the Finances API, and will not be returned in the response. - TRANSFER: This enumeration value indicates that the monetary transaction type involves a seller transferring money to eBay for reimbursement of a charge. For example, when a seller reimburses eBay for a buyer refund. - NON_SALE_CHARGE: This enumeration value indicates that the monetary transaction involves a non-transactional fee billed to the seller by eBay. These fees can include listing and listing upgrade fees, eBay store or other subscription fees, and ad fees. - ADJUSTMENT: This enumeration value indicates that the monetary transaction type is an adjustment (credit or debit) to the seller's account. - WITHDRAWAL: This enumeration value indicates that the monetary transaction type is an on-demand payout to the seller's account. If funds are available, a seller can request an on-demand payout.<br><br><b>Note</b>: On-demand payout is not available for sellers who are already on a <b>daily</b> payout schedule. In order to initiate an on-demand payout, a seller must be on a <b>weekly</b>, <b>bi-weekly</b>, or <b>monthly</b> payout schedule. - LOAN_REPAYMENT: This enumeration value indicates that the monetary transaction type is a loan repayment transaction.<br><br><b>Note</b>: eBay Seller Capital financing is only available in select marketplaces. Refer to <a href="/api-docs/sell/finances/overview.html#loans" target="_blank">Marketplace availability for eBay Seller Capital funding program</a> for current marketplace eligibility. - PURCHASE: This enumeration value indicates that the monetary transaction type is the purchase of an item by a seller using spendable funds.<br><br><b>Note</b>: This transaction type is currently only applicable in the US marketplace
- feeJurisdiction? FeeJurisdiction - This type defines the jurisdiction information associated with a fee, identifying the geographic or regulatory region under which the fee is applied
- orderLineItems? OrderLineItem[] - This array either shows the order line item transactional fees related to a <code>SALE</code> transaction and deducted from the payout associated with that order, or it shows the transactional fee credits going back to the seller in the case of a <code>REFUND</code> transaction
- transactionMemo? string - This field applies to shipping label transactions, sales transactions where payout is on hold, and non-sale charge fees
ebay.finances: Transactions
This is the base response type of the getTransactions method. The getTransactions response includes details on one or more monetary transactions that match the input criteria, as well as pagination data.
Fields
- next? string - The <b>getTransactions</b> method URI to use if you wish to view the next page of the result set. <br><br>This field is only returned if there is a next page of results to view based on the current input criteria
- total int - 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 <strong>limit</strong> and <strong>offset</strong> values, there may be additional pages in the results set
- offset int - 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 <strong>offset</strong> value in the request to <code>10</code>. <br><br>In the request, you can use the <b>offset</b> parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>30</code> and <b>limit</b> is set to <code>10</code>, the method retrieves monetary transactions 31 thru 40 from the resulting collection of monetary transactions. <br><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br><br><b>Default:</b> <code>0</code> (zero)
- prev? string - The <b>getTransactions</b> method URI to use if you wish to view the previous page of the result set. <br><br>This field is only returned if there is a previous page of results to view based on the current input criteria
- 'limit int - The maximum number of monetary transactions that may be returned per page of the result set. The <strong>limit</strong> value can be passed in as a query parameter, or if omitted, its value defaults to <code>20</code>. <br><br><span class="tablenote"><strong>Note:</strong> If this is the last or only page of the result set, the page may contain fewer monetary transactions than the <strong>limit</strong> value. To determine the number of pages in a result set, divide the <b>total</b> value (total number of monetary transactions matching input criteria) by this <strong>limit</strong> value, and then round up to the next integer. For example, if the <b>total</b> value was <code>120</code> (120 total monetary transactions) and the <strong>limit</strong> value was <code>50</code> (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 <strong>getTransactions</strong> calls to view all monetary transactions matching the input criteria. </span><br><br><b>Maximum:</b> <code>200</code> <br> <b>Default:</b> <code>20</code>
- href string - The URI of the <b>getTransactions</b> method request that produced the current page of the result set
- transactions 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)
ebay.finances: TransactionSummaryResponse
This type is the base response type of the getTransactionSummary method, and based on the filters that are used in the getTransactionSummary call URI, the response may include total count and amount of the seller's sales and credits, total count and amount of buyer refunds, and total count and amount of seller payment holds
Fields
- refundCount? int - This integer value indicates the total number of buyer refunds that match the input criteria
- purchaseCount? int - This integer value indicates the total number of purchases initiated by a seller using spendable funds
- transferAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- creditCount? int - This integer value indicates the total number of the seller's sales and/or credits that match the input criteria
- withdrawalCount? int - This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria
- transferCount? int - This integer value indicates the total number of buyer refund transfers that match the input criteria
- disputeBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- shippingLabelBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- disputeAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- loanRepaymentBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- balanceTransferCount? int - The total balance transfer count for given payee within the specified period
- withdrawalAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- balanceTransferBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- shippingLabelAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- adjustmentCount? int - Total adjustment count for given payee within a specified period
- onHoldAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- nonSaleChargeBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- transferBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- refundAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- refundBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- nonSaleChargeAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- onHoldBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- balanceTransferAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- creditBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- purchaseAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- disputeCount? int - This integer value indicates the total number of payment disputes
- onHoldCount? int - This integer value indicates the total number of order sales where the associated funds are on hold
- withdrawalBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- loanRepaymentAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- nonSaleChargeCount? int - The total non-sale charge count for given payee within a specified period
- shippingLabelCount? int - This is the total number of eBay shipping labels purchased by the seller
- purchaseBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- adjustmentBookingEntry? BookingEntryEnum - This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the <code>SALE</code> and <code>CREDIT</code> transaction types are credits to the seller's account. For sales proceeds in the <code>FUNDS_ON_HOLD</code> state, the dollar value shown in the <b>onHoldAmount</b> will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the <code>REFUND</code>, <code>DISPUTE</code>, <code>SHIPPING_LABEL</code>, and <code>TRANSFER</code> transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
- creditAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- loanRepaymentCount? int - This integer value indicates the total number of <code>LOAN_REPAYMENT</code> transactions
- adjustmentAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
ebay.finances: Transfer
This type is the base response type used by TRANSFER transaction type that is returned in the response
Fields
- transferDetail? TransferDetail - This type is used by the <b>transferDetail</b> container, which provides more details about the transfer and the charge(s) associated with the transfer
- transferAmount Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
- fundingSource? FundingSource - This type defines the source of funds used to finance a transfer, such as available seller funds, a credit card, or a bank account
- transactionDate string - This timestamp indicates the date/time of the transfer. The following (UTC) format is used: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. For example, <code>2020-08-04T19:09:02.768Z</code>
- transferId string - The unique identifier of the <code>TRANSFER</code> transaction type. This is the same value that was passed into the end of the call URI
ebay.finances: TransferDetail
This type is used by the transferDetail container, which provides more details about the transfer and the charge(s) associated with the transfer
Fields
- charges? Charge[] - This container is an array of one or more charges related to the transfer. Charges can be related to an order cancellation, order return, case, payment dispute, etc
- balanceAdjustment? BalanceAdjustment - This type is used by the <b>balanceAdjustment</b> container, which shows the seller payout balance that will be applied toward the charges outlined in the <b>charges</b> array
- totalChargeNetAmount? Amount - This type is used to express the dollar value and currency used for any transaction retrieved with the <strong>Finances API</strong>, including an order total, a seller payout, a buyer refund, or a seller credit
Union types
ebay.finances: TransactionTypeEnum
TransactionTypeEnum
This enumeration type defines the type of monetary transactions retrieved with the getTransactions method. | - SALE: This enumeration value indicates that the monetary transaction type is the sale of an order. - REFUND: This enumeration value indicates that the monetary transaction type is a buyer refund. - CREDIT: This enumeration value indicates that the monetary transaction type is a credit to the seller's account. - DISPUTE: This enumeration value indicates that the monetary transaction type involves a payment dispute between the buyer and seller. - SHIPPING_LABEL: This enumeration value indicates that the monetary transaction type involves eBay billing the seller for the purchase of an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
Note: eBay shipping label transactions paid through PayPal are not currently supported by the Finances API, and will not be returned in the response. - TRANSFER: This enumeration value indicates that the monetary transaction type involves a seller transferring money to eBay for reimbursement of a charge. For example, when a seller reimburses eBay for a buyer refund. - NON_SALE_CHARGE: This enumeration value indicates that the monetary transaction involves a non-transactional fee billed to the seller by eBay. These fees can include listing and listing upgrade fees, eBay store or other subscription fees, and ad fees. - ADJUSTMENT: This enumeration value indicates that the monetary transaction type is an adjustment (credit or debit) to the seller's account. - WITHDRAWAL: This enumeration value indicates that the monetary transaction type is an on-demand payout to the seller's account. If funds are available, a seller can request an on-demand payout.
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: This enumeration value indicates that the monetary transaction type is a loan repayment transaction.
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. - PURCHASE: This enumeration value indicates that the monetary transaction type is the purchase of an item by a seller using spendable funds.
Note: This transaction type is currently only applicable in the US marketplace
ebay.finances: CurrencyCodeEnum
CurrencyCodeEnum
This enumerated type lists the three-letter ISO 4217 code representing the supported world currencies. | - AED: United Arab Emirates Dirham
- AFN: Afghan Afghani
- ALL: Albanian Lek
- AMD: Armenian Dram
- AOA: Angolan Kwanza
- ARS: Argentine Peso
- AWG: Aruban Florin
- AZN: Azerbaijani Manat
- BAM: Bosnia-Herzegovina Convertible Mark
- BBD: Barbadian Dollar
- BDT: Bangladeshi Taka
- BGN: Bulgarian Lev
- BHD: Bahraini Dinar
- BIF: Burundian Franc
- BMD: Bermudian Dollar
- BND: Brunei Dollar
- BOB: Bolivian Boliviano
- BRL: Brazilian Real
- BSD: Bahamian Dollar
- BTN: Bhutanese Ngultrum
- BWP: Botswanan Pula
- BYR: Belarusian Ruble
- BZD: Belize Dollar
- CAD: Canadian Dollar
- CDF: Congolese Franc
- CLP: Chilean Peso
- CNY: Chinese Yuan
- COP: Colombian Peso
- CRC: Costa Rican Colon
- CUP: Cuban Peso
- CVE: Cape Verdean Escudo
- CZK: Czech Koruna
- DJF: Djiboutian Franc
- DOP: Dominican Peso
- DZD: Algerian Dinar
- EGP: Egyptian Pound
- ERN: Eritrean Nakfa
- ETB: Ethiopian Birr
- FJD: Fijian Dollar
- FKP: Falkland Islands Pound
- GEL: Georgian Lari
- GHS: Ghanaian Cedi
- GIP: Gibraltar Pound
- DKK: Danish Krone
- GMD: Gambian Dalasi
- GNF: Guinean Franc
- GTQ: Guatemalan Quetzal
- GYD: Guyanaese Dollar
- HKD: Hong Kong Dollar
- HNL: Honduran Lempira
- HRK: Croatian Kuna
- HTG: Haitian Gourde
- HUF: Hungarian Forint
- IDR: Indonesian Rupiah
- INR: Indian Rupee
- IQD: Iraqi Dinar
- IRR: Iranian Rial
- ISK: Icelandic Krona
- GBP: British Pound Sterling
- JMD: Jamaican Dollar
- JOD: Jordanian Dinar
- JPY: Japanese Yen
- KES: Kenyan Shilling
- KGS: Kyrgystani Som
- KHR: Cambodian Riel
- KMF: Comorian Franc
- KPW: North Korean Won
- KRW: South Korean Won
- KWD: Kuwaiti Dinar
- KYD: Cayman Islands Dollar
- KZT: Kazakhstani Tenge
- LAK: Laotian Kip
- LBP: Lebanese Pound
- CHF: Swiss Franc
- LKR: Sri Lankan Rupee
- LRD: Liberian Dollar
- LSL: Lesotho Loti
- LTL: Lithuanian Litas
- LYD: Libyan Dinar
- MAD: Moroccan Dirham
- MDL: Moldovan Leu
- MGA: Malagasy Ariary
- MKD: Macedonian Denar
- MMK: Myanma Kyat
- MNT: Mongolian Tugrik
- MOP: Macanese Pataca
- MRO: Mauritanian Ouguiya
- XCD: East Caribbean Dollar
- MUR: Mauritian Rupee
- MVR: Maldivian Rufiyaa
- MWK: Malawian Kwacha
- MXN: Mexican Peso
- MYR: Malaysian Ringgit
- MZN: Mozambican Metical
- NAD: Namibian Dollar
- NGN: Nigerian Naira
- NIO: Nicaraguan Cordoba
- NPR: Nepalese Rupee
- OMR: Omani Rial
- PAB: Panamanian Balboa
- PEN: Peruvian Nuevo Sol
- XPF: CFP Franc
- PGK: Papua New Guinean Kina
- PHP: Philippine Peso
- PKR: Pakistani Rupee
- PLN: Polish Zloty
- ILS: Israeli New Sheqel
- PYG: Paraguayan Guarani
- QAR: Qatari Rial
- RON: Romanian Leu
- RSD: Serbian Dinar
- RUB: Russian Ruble
- RWF: Rwandan Franc
- SAR: Saudi Riyal
- SBD: Solomon Islands Dollar
- SCR: Seychellois Rupee
- SDG: Sudanese Pound
- SEK: Swedish Krona
- SGD: Singapore Dollar
- SHP: Saint Helena Pound
- NOK: Norwegian Krone
- SLL: Sierra Leonean Leone
- SOS: Somali Shilling
- SRD: Surinamese Dollar
- STD: Sao Tome and Principe Dobra
- ANG: Netherlands Antillean Guilder
- SYP: Syrian Pound
- SZL: Swazi Lilangeni
- XAF: CFA Franc BEAC
- XOF: CFA Franc BCEAO
- THB: Thai Baht
- TJS: Tajikistani Somoni
- NZD: New Zealand Dollar
- TMT: Turkmenistani Manat
- TND: Tunisian Dinar
- TOP: Tongan Paanga
- TRY: Turkish Lira
- TTD: Trinidad and Tobago Dollar
- AUD: Australian Dollar
- TWD: New Taiwan Dollar
- TZS: Tanzanian Shilling
- UAH: Ukrainian Hryvnia
- UGX: Ugandan Shilling
- USD: United States Dollar
- UYU: Uruguayan Peso
- UZS: Uzbekistan Som
- VEF: Venezuelan Bolivar Fuerte
- VND: Vietnamese Dong
- VUV: Vanuatu Vatu
- WST: Samoan Tala
- YER: Yemeni Rial
- EUR: Euro
- ZAR: South African Rand
- ZMW: Zambian Kwacha
- ZWL: Zimbabwean Dollar
ebay.finances: ReferenceTypeEnum
ReferenceTypeEnum
An enumerated type that identifies the type of reference ID provided. | - CANCELLATION_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a cancellation. - CASE_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a case. - INVOICE: This enumeration value indicates that the ID provided refers to the unique identifier of an invoice. It indicates that the seller will be billed by invoice, and fees will not be deducted from the payout.
Note: This enumeration value applies only to NON_SALE_CHARGE transactions. - ITEM_ID: This enumeration value indicates that the ID provided refers to the unique identifier of an item. It is used to identify listing-related fees.
Note: This enumeration value applies only to NON_SALE_CHARGE transactions. - ORDER_ID: This enumeration value indicates that the ID provided refers to the unique identifier of an order.
Note: This enumeration value applies only to sales/transactions-related fees. - 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. - LOAN_REPAYMENT_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a repayment transaction.
Note: This is an externally assigned reference ID. It cannot be used to filter transactions. - RETURN_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a return. - PAYOUT_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a payout. - PSNAD_ID: This enumeration value indicates that the ID provided refers to the unique identifier of a Partial Significantly Not as Described (PSNAD) claim filed against an order
ebay.finances: PayoutStatusEnum
PayoutStatusEnum
This enumeration type lists the different possible states of an eBay payout to a seller's account. | - INITIATED: This enumeration value indicates that a payout was initiated. - SUCCEEDED: This enumeration value indicates a successful payout. - REVERSED: This enumeration value indicates that the payout was reversed. - RETRYABLE_FAILED: This enumeration value indicates that a payout failed, but eBay will try to process it again. - TERMINAL_FAILED: This enumeration value indicates that a payout failed, and it will not be tried again
ebay.finances: RegionTypeEnum
RegionTypeEnum
An enumerated value indicating the type of governing jurisdiction requiring the fee to be deducted from a seller's payout. | - COUNTRY: Indicates the governing jurisdiction is a country. - STATE_OR_PROVINCE: Indicates the governing jurisdiction is a state or province
ebay.finances: MarketplaceIdEnum
MarketplaceIdEnum
Defines the list of valid eBay marketplaces
ebay.finances: FeeTypeEnum
FeeTypeEnum
This enumerated type shows the fees that are automatically deducted from seller payouts. | - BELOW_STANDARD_FEE: This fee is charged to Below Standard sellers in addition to the FINAL_VALUE_FEE, and is based on a percentage of the order line item cost. - BELOW_STANDARD_SHIPPING_FEE: This fee is charged to Below Standard sellers in addition to the FINAL_VALUE_FEE, and is based on a percentage of the shipping cost for an order line item.
Note: This fee is bundled with the BELOW_STANDARD_FEE and not returned separately. - FINAL_VALUE_FEE_FIXED_PER_ORDER: This fee is a fixed-cost fee charged by eBay for every order (regardless of how many line items are in the order). This fee can vary by country. - FINAL_VALUE_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the order line item cost. The percentage varies by eBay category. - INTERNATIONAL_FEE: This fee is an international fee associated with an order line item if the seller's eBay registered address country is different than the buyer's registered address or delivery address. This fee is calculated as a percentage of the total amount of the order line item. - HIGH_ITEM_NOT_AS_DESCRIBED_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the order line item cost. - HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE: This fee may apply if a seller has a high number of 'not as described' claims, and is based on a percentage of the shipping cost for the order line item.
Note: This fee is bundled with the HIGH_ITEM_NOT_AS_DESCRIBED_FEE and not returned separately. - PAYMENT_PROCESSING_FEE: This is a payment processing fee charged for each order.
Note: This fee is bundled with the FINAL_VALUE_FEE_FIXED_PER_ORDER and not returned separately. - FINAL_VALUE_SHIPPING_FEE: This final value fee is charged to Above Standard and Top-rated sellers, and is based on a percentage of the shipping cost for the order line item. The percentage varies by eBay category.
Note: This fee is bundled with the FINAL_VALUE_FEE and not returned separately. - INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee for a listing. - BOLD_FEE: This enumeration value indicates that the account entry is a listing upgrade fee or credit for a listing title in boldface font. - FINANCE_FEE: This enumeration value indicates that the account entry is a finance charge to the user's account. - CATEGORY_FEATURED_FEE: This enumeration value indicates that the account entry is a credit for a listing upgrade fee for featuring the listing on an eBay category page relevant to the item.
Note: This feature is no longer available to most marketplaces and sellers. - NSFCHECK_FEE: This enumeration value indicates that the account entry is a fee charged by eBay when the seller's check does not clear due to insufficient funds. - PROMOTIONAL_CREDIT: This enumeration value indicates that the account entry is a promotional credit issued by eBay. - GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Picture Gallery. - FEATURED_GALLERY_FEE: This enumeration value indicates that the account entry is a fee charged or credit issued by eBay for listing an item in the Featured section at the top of the Picture Gallery page. - RESERVE_PRICE_FEE: This enumeration value indicates that the account entry is a fee charged or a credit refunded to the seller for a reserve price that was set for an auction listing. - IPIXPHOTO_FEE: This enumeration value is no longer applicable as the iPix photo feature is no longer available on any eBay marketplace. - LARGE_PICTURE_FEE: This enumeration value indicates that the account entry is a fee charged by eBay for a super-sized picture in a listing. - EBAY_STORE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged or a credit issued toward the user's eBay Store. - BUY_IT_NOW_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued by eBay if the seller uses the 'Buy It Now' feature on an auction listing. - SUBTITLE_FEE: This enumeration value indicates the account entry is a fee charged to the seller for adding a subtitle to a listing or a credit issued from eBay. - INTERNATIONAL_LISTING_FEE: This enumeration value indicates that the account entry is a 'cross-border trade' fee or credit. - PRO_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a credit towards the fee charged to the seller for using the Pro Pack Bundle feature pack. - MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a fee or a credit toward a fee for a Terapeak Research pro subscription. - VEHICLE_LOCAL_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee or a credit toward a monthly subscription fee charged for a National Vehicle subscription. - VEHICLE_LOCAL_INSERTION_FEE: This enumeration value indicates that the account entry is an insertion fee or a credit for a Motors local listing. - VALUE_PACK_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged or a credit towards the fee charged by eBay to the seller for using the Value Pack Bundle feature pack. - PRO_PACK_PLUS_BUNDLE_FEE: This enumeration value indicates the account entry is a fee charged by eBay to the seller for using the Pro Pack Plus Bundle feature pack. - GALLERY_PLUS_FEE: This enumeration value indicates that the account entry is a fee charged or a credit towards a fee charged by eBay for listing an item with the Gallery Plus feature. - EBAY_MOTORS_PRO_FEE: This enumeration value indicates that the account entry is an eBay Motors Pro fee or a credit towards an eBay Motors Pro fee. Applies to eBay Motors Pro registered dealers only. - PRIVATE_LISTING_FEE: This enumeration value indicates that the account entry is a fee for a private listing or a credit towards a fee charged. - AUCTION_END_EARLY_FEE: This enumeration value indicates that the account entry is a fee charged to the seller's account if the seller ends an auction (with bids) early. - STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE: This enumeration value indicates that the account entry is a fee charged or a credit toward a fee charged for early termination of an eBay Stores subscription. - AD_FEE: This enumeration value indicates that the account entry is a fee charged or a credit issued for an Ad on eBay. - EBAY_PLUS_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is an annual subscription fee charged a credit toward an annual subscription fee for an eBay Plus subscription. - VEHICLE_SUBSCRIPTION_FEE: This enumeration value indicates that the account entry is a monthly subscription fee charged a credit toward a monthly subscription fee for a National Vehicle subscription. - CO_FUNDING_COUPON_FEE: This enumeration value indicates that eBay is billing the seller or giving credit to the seller for a co-funding charge. - PAYMENT_DISPUTE_FEE: This enumeration value indicates the credit is a charge or a seller reimbursement for an eBay payment dispute fee. - PREMIUM_AD_FEES: This enumeration value indicates the invoice charged or the credit issued was for a Premium Ad Fee. - VEHICLES_BASIC_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Basic Package fee. - VEHICLES_PLUS_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Plus Package fee. - VEHICLES_PREMIUM_PACKAGE_FEE: This enumeration value indicates the invoice charged or the credit issued was for a Vehicles Listing Premium Package fee. - DEPOSIT_PROCESSING_FEE: This fee is charged to a seller when they sell a motor vehicle and require a deposit from the buyer. - EXPRESS_PAYOUT_FEE: This is the fee charged by eBay when a seller requests a payout through a debit card.
Note: If the requested payout to a debit card fails, the EXPRESS_PAYOUT_FEE will be credited back to the seller's account. - TAX_DEDUCTION_AT_SOURCE: This enumeration value indicates the account entry is the tax amount automatically deducted from a seller's payout. - INCOME_TAX_WITHHOLDING: This enumeration value indicates the account entry is the required income tax amount deducted from a seller's payout. - VAT_WITHHOLDING: This enumeration value indicates that the account entry is the required VAT amount deducted from the seller's payout. - BANK_PAYOUT_FEE: This enumeration value indicates that a fee is charged by eBay when a seller requests a payout through a bank account.
Note: BANK_PAYOUT_FEE is only applicable for CNY sellers and when the payoutInstrumentType is BANK. - CHARITY_DONATION: This enumeration value indicates the charitable donations against a sale. - REGULATORY_OPERATING_FEE: This enumeration value indicates that a fee is charged by eBay to cover the costs associated with complying with regulatory requirements in specific marketplaces. - OTHER_FEES: This enumeration value may be returned if the fee type cannot be determined, or has not been classified
ebay.finances: BookingEntryEnum
BookingEntryEnum
This enumerated type contains the values used to indicate whether the dollar value of a monetary transaction is a positive or negative value. | - CREDIT: This enumeration value indicates that the dollar value of the monetary transaction is a credit to the seller's account. Typically, the SALE and CREDIT transaction types are credits to the seller's account. For sales proceeds in the FUNDS_ON_HOLD state, the dollar value shown in the onHoldAmount will also show as seller credit. - DEBIT: This enumeration value indicates that the dollar value of the monetary transaction is a debit to the seller's account. Typically, the REFUND, DISPUTE, SHIPPING_LABEL, and TRANSFER transaction types are debits to the seller's account. Note that the shipping label functionality will initially only be available to a select number of sellers
ebay.finances: TransactionStatusEnum
TransactionStatusEnum
This enumeration type lists the different possible states of a monetary transaction, including payouts to sellers, refunds to buyers, and credits to a seller's account.
Note: The enumerations COMPLETED and FAILED apply to monetary transactions with the transactionType of TRANSFER. They only apply to monetary transactions where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
Import
import ballerinax/ebay.finances;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 50
Current verison: 1
Weekly downloads
Keywords
Vendor/eBay
Area/Finance & Accounting
Type/Connector
Contributors