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:TransactionStatusType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 14 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 14 elements, elem. wildcard
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:eBayPaymentStatus?, ns:CheckoutStatus?, ns:LastTimeModified?, ns:PaymentMethodUsed?, ns:CompleteStatus?, ns:BuyerSelectedShipping?, ns:PaymentHoldStatus?, ns:IntegratedMerchantCreditCardEnabled?, ns:eBayPaymentMismatchDetails?, ns:InquiryStatus?, ns:ReturnStatus?, ns:PaymentInstrument?, ns:DigitalStatus?, ns:CancelStatus?, {any}*
</...>
All Direct / Indirect Based Elements (1):
ns:Status (defined in ns:TransactionType complexType)
Known Usage Locations
Annotation
Contains the order status, e.g. the buyer's online payment and whether the checkout process for the order is complete.
XML Source (w/o annotations (15); see within schema source)
<xs:complexType name="TransactionStatusType">
<xs:sequence>
<xs:element minOccurs="0" name="eBayPaymentStatus" type="ns:PaymentStatusCodeType"/>
<xs:element minOccurs="0" name="CheckoutStatus" type="ns:CheckoutStatusCodeType"/>
<xs:element minOccurs="0" name="LastTimeModified" type="xs:dateTime"/>
<xs:element minOccurs="0" name="PaymentMethodUsed" type="ns:BuyerPaymentMethodCodeType"/>
<xs:element minOccurs="0" name="CompleteStatus" type="ns:CompleteStatusCodeType"/>
<xs:element minOccurs="0" name="BuyerSelectedShipping" type="xs:boolean"/>
<xs:element minOccurs="0" name="PaymentHoldStatus" type="ns:PaymentHoldStatusCodeType"/>
<xs:element minOccurs="0" name="IntegratedMerchantCreditCardEnabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="eBayPaymentMismatchDetails" type="ns:eBayPaymentMismatchDetailsType"/>
<xs:element minOccurs="0" name="InquiryStatus" type="ns:InquiryStatusCodeType"/>
<xs:element minOccurs="0" name="ReturnStatus" type="ns:ReturnStatusCodeType"/>
<xs:element minOccurs="0" name="PaymentInstrument" type="ns:BuyerPaymentInstrumentCodeType"/>
<xs:element minOccurs="0" name="DigitalStatus" type="ns:DigitalStatusCodeType"/>
<xs:element minOccurs="0" name="CancelStatus" type="ns:CancelStatusCodeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 15/15)
ns:BuyerSelectedShipping
Type:
xs:boolean, predefined, simple content
Indicates whether the buyer has selected shipping details during checkout. False indicates that the shipping service was selected by eBay for the buyer. For example, if the buyer has not yet completed the Review Your Purchase page, he has not picked a shipping service. If it is false, the application should ignore ShippingServiceCost and ShippingServiceSelected (items whose values are defaulted by eBay).
XML Representation Summary
<ns:BuyerSelectedShipping>
   
Content: 
{ xs:boolean }
</ns:BuyerSelectedShipping>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="BuyerSelectedShipping" type="xs:boolean"/>
ns:CancelStatus
Type:
ns:CancelStatusCodeType, simple content
The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on an order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.
XML Representation Summary
<ns:CancelStatus>
   
Content: 
{ enumeration of xs:token }
</ns:CancelStatus>
Simple Content
Enumeration:
see details at ns:CancelStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CancelStatus" type="ns:CancelStatusCodeType"/>
ns:CheckoutStatus
Type:
ns:CheckoutStatusCodeType, simple content
Indicates the current status of the checkout flow for the order.
XML Representation Summary
<ns:CheckoutStatus>
   
Content: 
{ enumeration of xs:token }
</ns:CheckoutStatus>
Simple Content
Enumeration:
"CheckoutComplete"
 - 
This value indicates that the buyer has paid and checkout is complete.
"CheckoutIncomplete"
 - 
This value indicates that checkout is incomplete, generally because the buyer has not paid yet.
"BuyerRequestsTotal"
 - 
This value indicates that the buyer wants to confirm the total price of the order line item before making a payment.
"SellerResponded"
 - 
This value indicates that the seller has just responded to the buyer concerning the total price of the order line item.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CheckoutStatus" type="ns:CheckoutStatusCodeType"/>
ns:CompleteStatus
Type:
ns:CompleteStatusCodeType, simple content
Indicates whether checkout is complete, incomplete, or pending for an order.
XML Representation Summary
<ns:CompleteStatus>
   
Content: 
{ enumeration of xs:token }
</ns:CompleteStatus>
Simple Content
Enumeration:
see details at ns:CompleteStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CompleteStatus" type="ns:CompleteStatusCodeType"/>
ns:DigitalStatus
Type:
ns:DigitalStatusCodeType, simple content
This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.
XML Representation Summary
<ns:DigitalStatus>
   
Content: 
{ enumeration of xs:token }
</ns:DigitalStatus>
Simple Content
Enumeration:
"Inactive"
 - 
This enumeration value indicates that the digital gift card has yet to be activated by the buyer or recipient of gift card.
"Activated"
 - 
This enumeration value indicates that the digital gift card has been activated by the buyer or recipient of gift card.
"Downloaded"
 - 
This enumeration value indicates that the digital gift card has been downloaded by the buyer or recipient of gift card. The next step would be to activate the gift card.
"Deactivated"
 - 
This enumeration value indicates that the digital gift card has been deactivated.
"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="DigitalStatus" type="ns:DigitalStatusCodeType"/>
ns:eBayPaymentMismatchDetails
Type:
ns:eBayPaymentMismatchDetailsType, complex content
This container is no longer used.
Component Diagram
XML Representation Summary
<ns:eBayPaymentMismatchDetails>
   
Content: 
ns:MismatchType?, ns:ActionRequiredBy?, ns:MismatchAmount?, {any}*
</ns:eBayPaymentMismatchDetails>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="eBayPaymentMismatchDetails" type="ns:eBayPaymentMismatchDetailsType"/>
ns:eBayPaymentStatus
Type:
ns:PaymentStatusCodeType, simple content
Indicates the success or failure of the buyer's online payment for an order. Applicable for the payment method that the buyer chose for the order. If the payment failed, the value returned indicates the reason for the failure.
XML Representation Summary
<ns:eBayPaymentStatus>
   
Content: 
{ enumeration of xs:token }
</ns:eBayPaymentStatus>
Simple Content
Enumeration:
"NoPaymentFailure"
 - 
This value indicates that the buyer's payment for the order has cleared. A CheckoutStatus.eBayPaymentStatus value of 'NoPaymentFailure' and a CheckoutStatus.Status value of 'Complete' indicates that checkout is complete.
"BuyerECheckBounced"
 - 
This value indicates that the buyer's eCheck bounced. This value is only applicable if the seller accepts eChecks as a form of payment.
"BuyerCreditCardFailed"
 - 
This value indicates that the buyer's payment via a credit card failed. This value is only applicable if the seller accepts credit cards as a form of payment.
"BuyerFailedPaymentReportedBySeller"
 - 
This value indicates that the seller reported the buyer's payment as failed.
"PayPalPaymentInProcess"
 - 
This value indicates that the buyer's PayPal payment is in process. This value is only applicable if the buyer has selected PayPal as the payment method.
"PaymentInProcess"
 - 
This value indicates that the buyer's non-PayPal payment is in process. This value is only applicable if the buyer has selected a payment method other than PayPal.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="eBayPaymentStatus" type="ns:PaymentStatusCodeType"/>
ns:InquiryStatus
Type:
ns:InquiryStatusCodeType, simple content
This field gives the status of a buyer's Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.
XML Representation Summary
<ns:InquiryStatus>
   
Content: 
{ enumeration of xs:token }
</ns:InquiryStatus>
Simple Content
Enumeration:
see details at ns:InquiryStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="InquiryStatus" type="ns:InquiryStatusCodeType"/>
ns:IntegratedMerchantCreditCardEnabled
Type:
xs:boolean, predefined, simple content
This field being returned with a value of true indicates that the order line item can be paid for with a credit card through the seller's payment gateway account.

Note: Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).

Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
XML Representation Summary
<ns:IntegratedMerchantCreditCardEnabled>
   
Content: 
{ xs:boolean }
</ns:IntegratedMerchantCreditCardEnabled>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="IntegratedMerchantCreditCardEnabled" type="xs:boolean"/>
ns:LastTimeModified
Type:
xs:dateTime, predefined, simple content
Indicates date and time an order's status was last updated (in GMT).
XML Representation Summary
<ns:LastTimeModified>
   
Content: 
{ xs:dateTime }
</ns:LastTimeModified>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LastTimeModified" type="xs:dateTime"/>
ns:PaymentHoldStatus
Type:
ns:PaymentHoldStatusCodeType, simple content
This field indicates the type and/or status of a payment hold on the item.

Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
XML Representation Summary
<ns:PaymentHoldStatus>
   
Content: 
{ enumeration of xs:token }
</ns:PaymentHoldStatus>
Simple Content
Enumeration:
see details at ns:PaymentHoldStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PaymentHoldStatus" type="ns:PaymentHoldStatusCodeType"/>
ns:PaymentInstrument
Type:
ns:BuyerPaymentInstrumentCodeType, simple content
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethodUsed field by the GetItemTransactions call.
XML Representation Summary
<ns:PaymentInstrument>
   
Content: 
{ enumeration of xs:token }
</ns:PaymentInstrument>
Simple Content
Enumeration:
see details at ns:BuyerPaymentInstrumentCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PaymentInstrument" type="ns:BuyerPaymentInstrumentCodeType"/>
ns:PaymentMethodUsed
Type:
ns:BuyerPaymentMethodCodeType, simple content
The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed, which is returned by the GetItemTransactions call, is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

Note: For sellers opted in to the eBay Managed Payments program, the enumeration value returned in this field will be CreditCard, regardless of the actual payment method used by the buyer to pay for the order.
XML Representation Summary
<ns:PaymentMethodUsed>
   
Content: 
{ enumeration of xs:token }
</ns:PaymentMethodUsed>
Simple Content
Enumeration:
see details at ns:BuyerPaymentMethodCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PaymentMethodUsed" type="ns:BuyerPaymentMethodCodeType"/>
ns:ReturnStatus
Type:
ns:ReturnStatusCodeType, simple content
This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return request, or has escalated an existing return request into a return case.
XML Representation Summary
<ns:ReturnStatus>
   
Content: 
{ enumeration of xs:token }
</ns:ReturnStatus>
Simple Content
Enumeration:
see details at ns:ReturnStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ReturnStatus" type="ns:ReturnStatusCodeType"/>
{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.