GET/transfer/{transfer_Id}
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
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
This method is supported in Sandbox environment. To access the endpoint, just replace the apiz.ebay.com root URI with apiz.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| transfer_Id | string | This path parameter is used to specify the unique identifier of the TRANSFER transaction type you wish to retrieve.Use the getTransactions method to retrieve this value by setting the transactionType filter to TRANSFER. The transfer_id value will then be returned in the transaction_id field of the response. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | This header identifies the seller's eBay marketplace. See HTTP request headers for the marketplace ID values. Note: If a marketplace ID value is not provided, the default value of EBAY_US is used. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.finances
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| fundingSource | FundingSource | This 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.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. Occurrence: Conditional |
| fundingSource.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. Occurrence: Conditional |
| fundingSource.type | string | The string value returned here indicates the funding source. Possible values include the following:
Occurrence: Conditional |
| transactionDate | string | This timestamp indicates the date/time of the transfer. The following (UTC) format is used: Occurrence: Always |
| transferAmount | Amount | The amount of the transfer being deducted from the funding source. Occurrence: Always |
| transferAmount.convertedFromCurrency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. Occurrence: Conditional |
| transferAmount.convertedFromValue | string | The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. Occurrence: Conditional |
| transferAmount.convertedToCurrency | CurrencyCodeEnum | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of Occurrence: Conditional |
| transferAmount.convertedToValue | string | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount. Occurrence: Conditional |
| transferAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferAmount.exchangeRate | string | The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. Occurrence: Conditional |
| transferAmount.value | string | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferDetail | TransferDetail | This 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.balanceAdjustment | BalanceAdjustment | This container shows the seller payout balance that will be applied toward the charges outlined in the charges array. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount | Amount | The seller payout balance amount that will be applied toward the charges outlined in the charges array. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.convertedFromCurrency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.convertedFromValue | string | The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.convertedToCurrency | CurrencyCodeEnum | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.convertedToValue | string | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.exchangeRate | string | The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. Occurrence: Conditional |
| transferDetail.balanceAdjustment.adjustmentAmount.value | string | The 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.adjustmentType | BookingEntryEnum | The enumeration value returned here indicates if the charge is a Occurrence: Conditional |
| transferDetail.charges | array of 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. Occurrence: Conditional |
| transferDetail.charges.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. Occurrence: Conditional |
| transferDetail.charges.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. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount | Amount | This 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.convertedFromCurrency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.convertedFromValue | string | The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.convertedToCurrency | CurrencyCodeEnum | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.convertedToValue | string | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.exchangeRate | string | The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. Occurrence: Conditional |
| transferDetail.charges.chargeNetAmount.value | string | The 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.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. Occurrence: Conditional |
| transferDetail.charges.orderId | string | The unique identifier of the order that is associated with the charge. Occurrence: Conditional |
| transferDetail.charges.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. Occurrence: Conditional |
| transferDetail.charges.refundId | string | The unique identifier of a buyer refund associated with the charge. Occurrence: Conditional |
| transferDetail.charges.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. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount | Amount | This container shows the total amount that the seller owes for all of the charges outlined in the charges array. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.convertedFromCurrency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.convertedFromValue | string | The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.convertedToCurrency | CurrencyCodeEnum | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.convertedToValue | string | Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY.The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.exchangeRate | string | The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. Occurrence: Conditional |
| transferDetail.totalChargeNetAmount.value | string | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| transferId | string | The unique identifier of the 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.
| Status | Meaning |
|---|---|
| 200 | Success. |
| 404 | Not found. |
| 500 | Internal Server Error. |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 135000 | API_FINANCES | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 135012 | API_FINANCES | REQUEST | The transfer id was not found. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: 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.
GEThttps://apiz.ebay.com/sell/finances/v1/transfer/5********5
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).