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:CheckoutStatusType"
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:eBayPaymentStatus?, ns:LastModifiedTime?, ns:PaymentMethod?, ns:Status?, ns:IntegratedMerchantCreditCardEnabled?, ns:eBayPaymentMismatchDetails?, ns:PaymentInstrument?, {any}*
</...>
All Direct / Indirect Based Elements (1):
ns:CheckoutStatus (defined in ns:OrderType complexType)
Known Usage Locations
Annotation
Type defining the CheckoutStatus container that is returned in GetOrders and GetOrderTransactions to indicate the current checkout status of the order.
XML Source (w/o annotations (8); see within schema source)
<xs:complexType name="CheckoutStatusType">
<xs:sequence>
<xs:element minOccurs="0" name="eBayPaymentStatus" type="ns:PaymentStatusCodeType"/>
<xs:element minOccurs="0" name="LastModifiedTime" type="xs:dateTime"/>
<xs:element minOccurs="0" name="PaymentMethod" type="ns:BuyerPaymentMethodCodeType"/>
<xs:element minOccurs="0" name="Status" type="ns:CompleteStatusCodeType"/>
<xs:element minOccurs="0" name="IntegratedMerchantCreditCardEnabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="eBayPaymentMismatchDetails" type="ns:eBayPaymentMismatchDetailsType"/>
<xs:element minOccurs="0" name="PaymentInstrument" type="ns:BuyerPaymentInstrumentCodeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 8/8)
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
This value indicates the payment status of an order.
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:IntegratedMerchantCreditCardEnabled
Type:
xs:boolean, predefined, simple content
This field being returned as true indicates that the order can be paid for through the seller's payment gateway account.

Note: As of May 1, 2019, no eBay marketplace support electronic payments through a seller's Integrated Merchant Credit Card (IMCC) account. To accept online credit card payments from buyers, a seller must use accept PayPal, or opt in to eBay managed payments program (if available to seller).

For sellers who are opted in to eBay managed payments, this field will actually be returned as true, but this will indicate that the seller is opted in to eBay managed payments, and does not indicate that the seller's IMCC account is being used for payments.

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:LastModifiedTime
Type:
xs:dateTime, predefined, simple content
Indicates the last time that there was a change in value of the CheckoutStatus.Status field, such as 'Pending' to 'Complete'.
XML Representation Summary
<ns:LastModifiedTime>
   
Content: 
{ xs:dateTime }
</ns:LastModifiedTime>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LastModifiedTime" type="xs:dateTime"/>
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 PaymentMethod field.
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:PaymentMethod
Type:
ns:BuyerPaymentMethodCodeType, simple content
The payment method that the buyer selected to pay for the order.

Note: For sellers opted in to eBay managed payments, a payment method is not needed at listing time, but this field is still returned. For eBay managed payments orders, the value returned in this field will be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the the value returned in this field will be CCAccepted. Either of these two values will be returned for eBay managed payments orders, regardless of the actual payment method that the buyer uses.
XML Representation Summary
<ns:PaymentMethod>
   
Content: 
{ enumeration of xs:token }
</ns:PaymentMethod>
Simple Content
Enumeration:
see details at ns:BuyerPaymentMethodCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PaymentMethod" type="ns:BuyerPaymentMethodCodeType"/>
ns:Status
Type:
ns:CompleteStatusCodeType, simple content
Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status field reads Incomplete when payment has yet to be initiated, Pending when payment has been initiated but is in process, and Complete when the payment process has completed.

Note: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The Status value will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
XML Representation Summary
<ns:Status>
   
Content: 
{ enumeration of xs:token }
</ns:Status>
Simple Content
Enumeration:
see details at ns:CompleteStatusCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Status" type="ns:CompleteStatusCodeType"/>
{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.