finances API1.4.0

getTransfer

GET
/transfer/{transfer_Id}
This method retrieves detailed information regarding a TRANSFER transaction type. A TRANSFER is a monetary transaction type that involves a seller transferring money to eBay for reimbursement of one or more charges. For example, when a seller reimburses eBay for a buyer refund.

If an ID is passed into the URI that is an identifier for another transaction type, this call will return an http status code of 404 Not found.

Input

Resource URI (production)

GET https://apiz.ebay.com/sell/finances/v1/transfer/{transfer_Id}

URI parameters

ParameterTypeDescription
transfer_IdstringThe unique identifier of the TRANSFER transaction type you wish to retrieve.

Occurrence: Required

HTTP request headers

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

OAuth scope

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

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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
fundingSourceFundingSourceThis container provides details about the seller's funding source to reimburse eBay for the transfer, such as a bank account, a credit card, or available seller payout funds.

Occurrence: Conditional

fundingSource.brandstringThe 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.

Occurrence: Conditional

fundingSource.memostringThis 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.

Occurrence: Conditional

fundingSource.typestringThe string value returned here indicates the funding source. Possible values include the following:
  • AVAILABLE_FUNDS: transfer is funded with seller payout funds
  • CREDIT_CARD: transfer is funded with seller's credit card
  • BANK: transfer is funded with a direct debit to seller's bank account on file with eBay
  • PAY_UPON_INVOICE: eBay will bill the seller for the transfer on the monthly invoice

Occurrence: Conditional

transactionDatestringThis timestamp indicates the date/time of the transfer. The following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2020-08-04T19:09:02.768Z

Occurrence: Always

transferAmountAmountThe amount of the transfer being deducted from the funding source.

Occurrence: Always

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

transferDetailTransferDetailThis container provides more details about the transfer, including details on the charge(s) associated with the transfer. Multiple charges can be addressed with one transfer.

Occurrence: Conditional

transferDetail.balanceAdjustmentBalanceAdjustmentThis container shows the seller payout balance that will be applied toward the charges outlined in the charges array.

Occurrence: Conditional

transferDetail.balanceAdjustment.adjustmentAmountAmountThe seller payout balance amount that will be applied toward the charges outlined in the charges array.

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

transferDetail.balanceAdjustment.adjustmentAmount.exchangeRatestringThe exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

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

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

Occurrence: Conditional

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

Occurrence: Conditional

transferDetail.balanceAdjustment.adjustmentTypeBookingEntryEnumThe enumeration value returned here indicates if the charge is a DEBIT or a CREDIT to the seller. Generally, all transfer transaction types are going to be DEBIT, since the money is being tranferred from the seller to eBay.

Occurrence: Conditional

transferDetail.chargesarray of ChargeThis 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.

Occurrence: Conditional

transferDetail.charges.cancellationIdstringThe unique identifier of an order cancellation. This field is only applicable and returned if the charge is related to an order cancellation.

Occurrence: Conditional

transferDetail.charges.caseIdstringThe 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.

Occurrence: Conditional

transferDetail.charges.chargeNetAmountAmountThis container shows the net amount of the charge, which is the total amount of the charge minus the total amount of fees credited towards this refund as per eBay policy. It is possible for there to be multiple charges from multiple orders with one transfer. The net aggregate amount for all charges found in the charges array can be found in the transferDetail.totalChargeNetAmount container.

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

transferDetail.charges.chargeNetAmount.exchangeRatestringThe exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

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

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

Occurrence: Conditional

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

Occurrence: Conditional

transferDetail.charges.inquiryIdstringThe 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.

Occurrence: Conditional

transferDetail.charges.orderIdstringThe unique identifier of the order that is associated with the charge.

Occurrence: Conditional

transferDetail.charges.paymentDisputeIdstringThe 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.

Occurrence: Conditional

transferDetail.charges.refundIdstringThe unique identifier of a buyer refund associated with the charge.

Occurrence: Conditional

transferDetail.charges.returnIdstringThe 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.

Occurrence: Conditional

transferDetail.totalChargeNetAmountAmountThis container shows the total amount that the seller owes for all of the charges outlined in the charges array.

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

transferIdstringThe unique identifier of the TRANSFER transaction type. This is the same value that was passed into the end of the call URI.

Occurrence: Always

HTTP status codes

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

StatusMeaning
200Success.
404Not found.
500Internal Server Error.

Error codes

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

CodeDomainCategoryMeaning
135000API_FINANCESAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
135012API_FINANCESREQUESTThe transfer id was not found.

Warnings

Samples

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

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

Sample 1: Retrieve details of a transfer

This call retrieves details of a specific transfer, and the charges related to that transfer.

Input

The seller passes in the unique identifier of the transfer at the end of the call URI. There are no other parameters for this method.
GET
https://apiz.ebay.com/sell/finances/v1/transfer/5000732055

Output

The output of the call shows that the transfer amount is $123.00, and this amount will be debited to the seller's Visa credit card. If you look at the charges array, you see that there are four buyer-initiated cases and three third-party payment disputes that are a part of this transfer.

Although this particular transfer involves a $123.00 debit to the seller's Visa credit card, the seller actually owes a balance of $467.12 (shown in the totalChargeNetAmount container) to eBay for the four cases and three payment disputes. Subtracting $123.00 from $467.12, the seller still owes eBay a balance of $344.12 (shown in the balanceAdjustment container).