eBay Trading APIVersion 1119

CheckoutStatusType

Type defining the CheckoutStatus container that is returned in GetOrders and GetOrderTransactions to indicate the current checkout status of the order.

Type that uses CheckoutStatusType:

Calls that use CheckoutStatusType:

Fields



eBayPaymentMismatchDetails ( eBayPaymentMismatchDetailsType ) [0..1]
Not used by any call.

This container is no longer used.
See the Field Index to learn which calls use eBayPaymentMismatchDetails.

eBayPaymentStatus ( PaymentStatusCodeType ) [0..1]
This value indicates the payment status of an order.
See the Field Index to learn which calls use eBayPaymentStatus.

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
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.
See the Field Index to learn which calls use IntegratedMerchantCreditCardEnabled.

LastModifiedTime ( dateTime ) [0..1]
Indicates the last time that there was a change in value of the CheckoutStatus.Status field, such as 'Pending' to 'Complete'.
See the Field Index to learn which calls use LastModifiedTime.

PaymentInstrument ( BuyerPaymentInstrumentCodeType ) [0..1]
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.
See the Field Index to learn which calls use PaymentInstrument.

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.
See the Field Index to learn which calls use PaymentMethod.

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 lt;code>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.
See the Field Index to learn which calls use Status.