eBay::API::XML::DataType::TransactionStatusType(3)

NAME
eBay::API::XML::DataType::TransactionStatusType

DESCRIPTION
Contains the transaction status, e.g. the buyer's online payment and whether the checkout process for the transaction is complete.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::TransactionStatusType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setBuyerSelectedShipping()
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).

# Argument: 'xs:boolean'

  isBuyerSelectedShipping()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:boolean'

  setCheckoutStatus()
Indicates the current status of the checkout process for the transaction.

# Argument: 'ns:CheckoutStatusCodeType'

  getCheckoutStatus()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:CheckoutStatusCodeType'

  setCompleteStatus()
Indicates whether the transaction process is complete or incomplete.

# Argument: 'ns:CompleteStatusCodeType'

  getCompleteStatus()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:CompleteStatusCodeType'

  setLastTimeModified()
Indicates date and time a transaction's status or incomplete state was last updated (in GMT).

# Argument: 'xs:dateTime'

  getLastTimeModified()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:dateTime'

  setPaymentHoldStatus()
Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Additionally, in the cases of the GetMyeBaySelling and GetMyeBayBuying calls, the PaymentHoldStatus value can affect the value returned in in SellerPaidStatus and BuyerPaidStatus; see the PaymentHoldStatus applicable values.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=HoldsOnPayPalPayments Title: Holds on PayPal Payments

# Argument: 'ns:PaymentHoldStatusCodeType'

  getPaymentHoldStatus()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrders
  Returned: Conditionally
  Details: DetailLevel: none

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: WonList
           DeletedFromWonList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: SoldList
           DeletedFromSoldList

# Returns: 'ns:PaymentHoldStatusCodeType'

  setPaymentMethodUsed()
Payment method the buyer selected for paying the seller for the transaction. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

# Argument: 'ns:BuyerPaymentMethodCodeType'

  getPaymentMethodUsed()
  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:BuyerPaymentMethodCodeType'

  setEBayPaymentStatus()
Indicates the success or failure of the buyer's online payment for a transaction. Only applicable if the buyer chose PayPal as the payment method for the transaction. If the payment failed, the value returned indicates the reason for the failure. Output only.

# Argument: 'ns:PaymentStatusCodeType'

  getEBayPaymentStatus()
  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:PaymentStatusCodeType'