complexType "ns:ExternalTransactionType"

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:ExternalTransactionType"

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

Component Diagram

XML Representation Summary

<...>

Content:

ns:ExternalTransactionID?, ns:ExternalTransactionTime?, ns:FeeOrCreditAmount?, ns:PaymentOrRefundAmount?, ns:ExternalTransactionStatus?, {any}*

</...>

All Direct / Indirect Based Elements (3):

ns:ExternalTransaction (defined in ns:OrderType complexType),

ns:ExternalTransaction (defined in ns:TransactionType complexType),

ns:ExternalTransaction (in ns:ReviseCheckoutStatusRequest)

Known Usage Locations

As direct type of elements (3):

ns:ExternalTransaction (defined in ns:OrderType complexType),

ns:ExternalTransaction (defined in ns:TransactionType complexType),

ns:ExternalTransaction (in ns:ReviseCheckoutStatusRequest)

Annotation

Container consisting of details related to payment of an eBay order on an external system such as PayPal. This container is only returned if payment has been made on an order. For GetSellerTransaactions and GetItemTransactions, this container is not returned for multiple line item orders.

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

<xs:complexType name="ExternalTransactionType">

<xs:sequence>

<xs:element minOccurs="0" name="ExternalTransactionID" type="xs:string"/>

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

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

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

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

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

</xs:sequence>

</xs:complexType>

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

ns:ExternalTransactionID

Type:

xs:string, predefined, simple content

Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made.

XML Representation Summary

<ns:ExternalTransactionID>

Content:

{ xs:string }

</ns:ExternalTransactionID>

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

<xs:element minOccurs="0" name="ExternalTransactionID" type="xs:string"/>

ns:ExternalTransactionStatus

Type:

ns:PaymentTransactionStatusCodeType, simple content

The current processing status of a PayPal payment for an eBay order.

XML Representation Summary

<ns:ExternalTransactionStatus>

Content:

{ enumeration of xs:token }

</ns:ExternalTransactionStatus>

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="ExternalTransactionStatus" type="ns:PaymentTransactionStatusCodeType"/>

ns:ExternalTransactionTime

Type:

xs:dateTime, predefined, simple content

Timestamp for payment transaction.

XML Representation Summary

<ns:ExternalTransactionTime>

Content:

{ xs:dateTime }

</ns:ExternalTransactionTime>

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

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

ns:FeeOrCreditAmount

Type:

ns:AmountType, simple content

Fee Amount is a positive value and Credit Amount is a negative value.

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:PaymentOrRefundAmount

Type:

ns:AmountType, simple content

If this dollar value is a positive amount, this is the amount that the buyer pays the seller through PayPal for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer.

Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller.
Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the PaymentOrRefundAmount value (for the payment scenario). To determine if 'Collect and Remit' taxes were added into PaymentOrRefundAmount value, the user can check for the Transaction.eBayCollectAndRemitTaxes.TaxDetails and the Transaction.Taxes.TaxDetails containers in the response. If both of these containers appear in the response with a TaxDetails.TaxDescription value of SalesTax (in US) or GST (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.

Component Diagram

XML Representation Summary

<ns:PaymentOrRefundAmount

currencyID

Content:

{ xs:double }

</ns:PaymentOrRefundAmount>

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

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

{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.