complexType "ns:RefundTransactionInfoType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:RefundTransactionInfoType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 7 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 7 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

ns:RefundStatus?, ns:RefundType?, ns:RefundTo?, ns:RefundTime?, ns:RefundAmount?, ns:ReferenceID?, ns:FeeOrCreditAmount?, {any}*

</...>

All Direct / Indirect Based Elements (1):

ns:Refund (in ns:Refunds)

Known Usage Locations

As direct type of elements (1):

ns:Refund (in ns:Refunds)

Annotation

Type defining the Refund container, which consists of detailed information on an In-Store Pickup item refund.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.

XML Source (w/o annotations (8); see within schema source)

<xs:complexType name="RefundTransactionInfoType">

<xs:sequence>

<xs:element minOccurs="0" name="RefundStatus" type="ns:PaymentTransactionStatusCodeType"/>

<xs:element minOccurs="0" name="RefundType" type="ns:RefundSourceTypeCodeType"/>

<xs:element minOccurs="0" name="RefundTo" type="ns:UserIdentityType"/>

<xs:element minOccurs="0" name="RefundTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="RefundAmount" type="ns:AmountType"/>

<xs:element minOccurs="0" name="ReferenceID" type="ns:TransactionReferenceType"/>

<xs:element minOccurs="0" name="FeeOrCreditAmount" type="ns:AmountType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 8/8)

ns:FeeOrCreditAmount

Type:

ns:AmountType, simple content

This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Component Diagram

XML Representation Summary

<ns:FeeOrCreditAmount

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:FeeOrCreditAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="FeeOrCreditAmount" type="ns:AmountType"/>

ns:ReferenceID

Type:

ns:TransactionReferenceType, simple content

This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Component Diagram

XML Representation Summary

<ns:ReferenceID

type

("ExternalTransactionID" | "MandateReferenceNumber" | "CustomCode")

Content:

{ xs:string }

</ns:ReferenceID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ReferenceID" type="ns:TransactionReferenceType"/>

ns:RefundAmount

Type:

ns:AmountType, simple content

This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Component Diagram

XML Representation Summary

<ns:RefundAmount

currencyID

Content:

{ xs:double }

</ns:RefundAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundAmount" type="ns:AmountType"/>

ns:RefundStatus

Type:

ns:PaymentTransactionStatusCodeType, simple content

This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

XML Representation Summary

<ns:RefundStatus>

Content:

{ enumeration of xs:token }

</ns:RefundStatus>

Simple Content

Enumeration:

"Failed"	-	This value indicates that the payment transaction failed.
"Succeeded"	-	This value indicates that the payment transaction succeeded. If the payment transaction is a buyer's payment for an order, once this `Succeeded` value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the `Succeeded` value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the `Pending` value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from `Pending` to `Succeeded`.
"Pending"	-	This value indicates that the payment transaction is pending. Note: Previously, the `Succeeded` value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the `Pending` value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from `Pending` to `Succeeded`.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundStatus" type="ns:PaymentTransactionStatusCodeType"/>

ns:RefundTime

Type:

xs:dateTime, predefined, simple content

This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

XML Representation Summary

<ns:RefundTime>

Content:

{ xs:dateTime }

</ns:RefundTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundTime" type="xs:dateTime"/>

ns:RefundTo

Type:

ns:UserIdentityType, simple content

This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Component Diagram

XML Representation Summary

<ns:RefundTo

type

("eBayUser" | "eBayPartner" | "CustomCode")

Content:

{ xs:string }

</ns:RefundTo>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundTo" type="ns:UserIdentityType"/>

ns:RefundType

Type:

ns:RefundSourceTypeCodeType, simple content

This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

XML Representation Summary

<ns:RefundType>

Content:

{ enumeration of xs:token }

</ns:RefundType>

Simple Content

Enumeration:

"StoreCredit"	-	This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).
"PaymentRefund"	-	This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
"CustomCode"	-	This value is reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundType" type="ns:RefundSourceTypeCodeType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.