TransactionType (stSoftware API)

java.lang.Object
- com.aspc.cms.cart.paypal.service.TransactionType

public class TransactionType
extends java.lang.Object

Contains information about a single transaction. A transaction contains information about the sale of a particular item. The system creates a transaction when a buyer has made a purchase (Fixed Price items) or is the winning bidder (BIN and auction items). A listing can be associated with one or more transactions in these cases: Multi-Item Fixed Price Listings Dutch Auction Listings A listing is associated with a single transaction in these cases: Single-Item Fixed Price Listings Single-Item Auction Listings

Java class for TransactionType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="TransactionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:ebay:apis:eBLBaseComponents}AmountPaid" minOccurs="0"/>
         <element name="Buyer" type="{urn:ebay:apis:eBLBaseComponents}UserType" minOccurs="0"/>
         <element ref="{urn:ebay:apis:eBLBaseComponents}ShippingDetails" minOccurs="0"/>
         <element name="ConvertedAmountPaid" type="{urn:ebay:apis:CoreComponentTypes}AmountType" minOccurs="0"/>
         <element name="ConvertedTransactionPrice" type="{urn:ebay:apis:CoreComponentTypes}AmountType" minOccurs="0"/>
         <element name="CreatedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="DepositType" type="{urn:ebay:apis:eBLBaseComponents}DepositTypeCodeType" minOccurs="0"/>
         <element name="Item" type="{urn:ebay:apis:eBLBaseComponents}ItemType" minOccurs="0"/>
         <element name="QuantityPurchased" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ShippingHandlingTotal" type="{urn:ebay:apis:CoreComponentTypes}AmountType" minOccurs="0"/>
         <element name="Status" type="{urn:ebay:apis:eBLBaseComponents}TransactionStatusType" minOccurs="0"/>
         <element ref="{urn:ebay:apis:eBLBaseComponents}TransactionID" minOccurs="0"/>
         <element ref="{urn:ebay:apis:eBLBaseComponents}AuthorizationID"/>
         <element name="TransactionPrice" type="{urn:ebay:apis:CoreComponentTypes}AmountType" minOccurs="0"/>
         <element name="VATPercent" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AmountType`	`amountPaid`
`protected java.lang.String`	`authorizationID`
`protected UserType`	`buyer`
`protected AmountType`	`convertedAmountPaid`
`protected AmountType`	`convertedTransactionPrice`
`protected javax.xml.datatype.XMLGregorianCalendar`	`createdDate`
`protected DepositTypeCodeType`	`depositType`
`protected ItemType`	`item`
`protected java.lang.Integer`	`quantityPurchased`
`protected ShippingDetailsType`	`shippingDetails`
`protected AmountType`	`shippingHandlingTotal`
`protected TransactionStatusType`	`status`
`protected java.lang.String`	`transactionID`
`protected AmountType`	`transactionPrice`
`protected java.math.BigDecimal`	`vatPercent`

Constructor Summary

Constructors
Constructor and Description

TransactionType()

Constructors
Constructor and Description
`TransactionType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmountType`	`getAmountPaid()` The amount the buyer paid for the item or agreed to pay, depending on how far into the checkout process the item is.
`java.lang.String`	`getAuthorizationID()` Unique identifier for an authorization.
`UserType`	`getBuyer()` Gets the value of the buyer property.
`AmountType`	`getConvertedAmountPaid()` Gets the value of the convertedAmountPaid property.
`AmountType`	`getConvertedTransactionPrice()` Gets the value of the convertedTransactionPrice property.
`javax.xml.datatype.XMLGregorianCalendar`	`getCreatedDate()` Gets the value of the createdDate property.
`DepositTypeCodeType`	`getDepositType()` Gets the value of the depositType property.
`ItemType`	`getItem()` Gets the value of the item property.
`java.lang.Integer`	`getQuantityPurchased()` Gets the value of the quantityPurchased property.
`ShippingDetailsType`	`getShippingDetails()` Includes shipping payment data.
`AmountType`	`getShippingHandlingTotal()` Gets the value of the shippingHandlingTotal property.
`TransactionStatusType`	`getStatus()` Gets the value of the status property.
`java.lang.String`	`getTransactionID()` Unique identifier for a transaction.
`AmountType`	`getTransactionPrice()` Gets the value of the transactionPrice property.
`java.math.BigDecimal`	`getVATPercent()` Gets the value of the vatPercent property.
`void`	`setAmountPaid(AmountType value)` Sets the value of the amountPaid property.
`void`	`setAuthorizationID(java.lang.String value)` Sets the value of the authorizationID property.
`void`	`setBuyer(UserType value)` Sets the value of the buyer property.
`void`	`setConvertedAmountPaid(AmountType value)` Sets the value of the convertedAmountPaid property.
`void`	`setConvertedTransactionPrice(AmountType value)` Sets the value of the convertedTransactionPrice property.
`void`	`setCreatedDate(javax.xml.datatype.XMLGregorianCalendar value)` Sets the value of the createdDate property.
`void`	`setDepositType(DepositTypeCodeType value)` Sets the value of the depositType property.
`void`	`setItem(ItemType value)` Sets the value of the item property.
`void`	`setQuantityPurchased(java.lang.Integer value)` Sets the value of the quantityPurchased property.
`void`	`setShippingDetails(ShippingDetailsType value)` Sets the value of the shippingDetails property.
`void`	`setShippingHandlingTotal(AmountType value)` Sets the value of the shippingHandlingTotal property.
`void`	`setStatus(TransactionStatusType value)` Sets the value of the status property.
`void`	`setTransactionID(java.lang.String value)` Sets the value of the transactionID property.
`void`	`setTransactionPrice(AmountType value)` Sets the value of the transactionPrice property.
`void`	`setVATPercent(java.math.BigDecimal value)` Sets the value of the vatPercent property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - amountPaid
```
protected AmountType amountPaid
```
  - buyer
```
protected UserType buyer
```
  - shippingDetails
```
protected ShippingDetailsType shippingDetails
```
  - convertedAmountPaid
```
protected AmountType convertedAmountPaid
```
  - convertedTransactionPrice
```
protected AmountType convertedTransactionPrice
```
  - createdDate
```
protected javax.xml.datatype.XMLGregorianCalendar createdDate
```
  - depositType
```
protected DepositTypeCodeType depositType
```
  - item
```
protected ItemType item
```
  - quantityPurchased
```
protected java.lang.Integer quantityPurchased
```
  - shippingHandlingTotal
```
protected AmountType shippingHandlingTotal
```
  - status
```
protected TransactionStatusType status
```
  - transactionID
```
protected java.lang.String transactionID
```
  - authorizationID
```
protected java.lang.String authorizationID
```
  - transactionPrice
```
protected AmountType transactionPrice
```
  - vatPercent
```
protected java.math.BigDecimal vatPercent
```
- Constructor Detail
  - TransactionType
```
public TransactionType()
```
- Method Detail
  - getAmountPaid
```
public AmountType getAmountPaid()
```
    The amount the buyer paid for the item or agreed to pay, depending on how far into the checkout process the item is. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by calling GetSellerTransactions or GetSellerTransactions and comparing the AmountPaid value to what the seller expected. For Motors items, AmountPaid is the amount paid by the buyer for the deposit.
    
    Returns:
    
    the value possible object is AmountType
  - setAmountPaid
```
public void setAmountPaid(AmountType value)
```
    Sets the value of the amountPaid property.
    
    Parameters:
    
    value - the value allowed object is AmountType
  - getBuyer
```
public UserType getBuyer()
```
    Gets the value of the buyer property.
    
    Returns:
    
    the value possible object is UserType
  - setBuyer
```
public void setBuyer(UserType value)
```
    Sets the value of the buyer property.
    
    Parameters:
    
    value - the value allowed object is UserType
  - getShippingDetails
```
public ShippingDetailsType getShippingDetails()
```
    Includes shipping payment data.
    
    Returns:
    
    the value possible object is ShippingDetailsType
  - setShippingDetails
```
public void setShippingDetails(ShippingDetailsType value)
```
    Sets the value of the shippingDetails property.
    
    Parameters:
    
    value - the value allowed object is ShippingDetailsType
  - getConvertedAmountPaid
```
public AmountType getConvertedAmountPaid()
```
    Gets the value of the convertedAmountPaid property.
    
    Returns:
    
    the value possible object is AmountType
  - setConvertedAmountPaid
```
public void setConvertedAmountPaid(AmountType value)
```
    Sets the value of the convertedAmountPaid property.
    
    Parameters:
    
    value - the value allowed object is AmountType
  - getConvertedTransactionPrice
```
public AmountType getConvertedTransactionPrice()
```
    Gets the value of the convertedTransactionPrice property.
    
    Returns:
    
    the value possible object is AmountType
  - setConvertedTransactionPrice
```
public void setConvertedTransactionPrice(AmountType value)
```
    Sets the value of the convertedTransactionPrice property.
    
    Parameters:
    
    value - the value allowed object is AmountType
  - getCreatedDate
```
public javax.xml.datatype.XMLGregorianCalendar getCreatedDate()
```
    Gets the value of the createdDate property.
    
    Returns:
    
    the value possible object is XMLGregorianCalendar
  - setCreatedDate
```
public void setCreatedDate(javax.xml.datatype.XMLGregorianCalendar value)
```
    Sets the value of the createdDate property.
    
    Parameters:
    
    value - the value allowed object is XMLGregorianCalendar
  - getDepositType
```
public DepositTypeCodeType getDepositType()
```
    Gets the value of the depositType property.
    
    Returns:
    
    the value possible object is DepositTypeCodeType
  - setDepositType
```
public void setDepositType(DepositTypeCodeType value)
```
    Sets the value of the depositType property.
    
    Parameters:
    
    value - the value allowed object is DepositTypeCodeType
  - getItem
```
public ItemType getItem()
```
    Gets the value of the item property.
    
    Returns:
    
    the value possible object is ItemType
  - setItem
```
public void setItem(ItemType value)
```
    Sets the value of the item property.
    
    Parameters:
    
    value - the value allowed object is ItemType
  - getQuantityPurchased
```
public java.lang.Integer getQuantityPurchased()
```
    Gets the value of the quantityPurchased property.
    
    Returns:
    
    the value possible object is Integer
  - setQuantityPurchased
```
public void setQuantityPurchased(java.lang.Integer value)
```
    Sets the value of the quantityPurchased property.
    
    Parameters:
    
    value - the value allowed object is Integer
  - getShippingHandlingTotal
```
public AmountType getShippingHandlingTotal()
```
    Gets the value of the shippingHandlingTotal property.
    
    Returns:
    
    the value possible object is AmountType
  - setShippingHandlingTotal
```
public void setShippingHandlingTotal(AmountType value)
```
    Sets the value of the shippingHandlingTotal property.
    
    Parameters:
    
    value - the value allowed object is AmountType
  - getStatus
```
public TransactionStatusType getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    the value possible object is TransactionStatusType
  - setStatus
```
public void setStatus(TransactionStatusType value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - the value allowed object is TransactionStatusType
  - getTransactionID
```
public java.lang.String getTransactionID()
```
    Unique identifier for a transaction. Returns 0 when Type=1 (Chinese auction). Typically, an ItemID and a TransactionID uniquely identify a checkout transaction.
    
    Returns:
    
    the value possible object is String
  - setTransactionID
```
public void setTransactionID(java.lang.String value)
```
    Sets the value of the transactionID property.
    
    Parameters:
    
    value - the value allowed object is String
  - getAuthorizationID
```
public java.lang.String getAuthorizationID()
```
    Unique identifier for an authorization.
    
    Returns:
    
    the value possible object is String
  - setAuthorizationID
```
public void setAuthorizationID(java.lang.String value)
```
    Sets the value of the authorizationID property.
    
    Parameters:
    
    value - the value allowed object is String
  - getTransactionPrice
```
public AmountType getTransactionPrice()
```
    Gets the value of the transactionPrice property.
    
    Returns:
    
    the value possible object is AmountType
  - setTransactionPrice
```
public void setTransactionPrice(AmountType value)
```
    Sets the value of the transactionPrice property.
    
    Parameters:
    
    value - the value allowed object is AmountType
  - getVATPercent
```
public java.math.BigDecimal getVATPercent()
```
    Gets the value of the vatPercent property.
    
    Returns:
    
    the value possible object is BigDecimal
  - setVATPercent
```
public void setVATPercent(java.math.BigDecimal value)
```
    Sets the value of the vatPercent property.
    
    Parameters:
    
    value - the value allowed object is BigDecimal

Class TransactionType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

amountPaid

buyer

shippingDetails

convertedAmountPaid

convertedTransactionPrice

createdDate

depositType

item

quantityPurchased

shippingHandlingTotal

status

transactionID

authorizationID

transactionPrice

vatPercent

Constructor Detail

TransactionType

Method Detail

getAmountPaid

setAmountPaid

getBuyer

setBuyer

getShippingDetails

setShippingDetails

getConvertedAmountPaid

setConvertedAmountPaid

getConvertedTransactionPrice

setConvertedTransactionPrice

getCreatedDate

setCreatedDate

getDepositType

setDepositType

getItem

setItem

getQuantityPurchased

setQuantityPurchased

getShippingHandlingTotal

setShippingHandlingTotal

getStatus

setStatus

getTransactionID

setTransactionID

getAuthorizationID

setAuthorizationID

getTransactionPrice

setTransactionPrice

getVATPercent

setVATPercent