complexType "ns:PaymentTransactionType"

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:PaymentTransactionType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 8 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 8 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

ns:PaymentStatus?, ns:Payer?, ns:Payee?, ns:PaymentTime?, ns:PaymentAmount?, ns:ReferenceID?, ns:FeeOrCreditAmount?, ns:PaymentReferenceID*, {any}*

</...>

All Direct / Indirect Based Elements (1):

ns:Payment (in ns:Payments defined in ns:PaymentsInformationType complexType)

Known Usage Locations

As direct type of elements (1):

ns:Payment (in ns:Payments defined in ns:PaymentsInformationType complexType)

Annotation

This type contains details about the allocation of funds to one payee from a buyer payment for a specified order.

XML Source (w/o annotations (9); see within schema source)

<xs:complexType name="PaymentTransactionType">

<xs:sequence>

<xs:element minOccurs="0" name="PaymentStatus" type="ns:PaymentTransactionStatusCodeType"/>

<xs:element minOccurs="0" name="Payer" type="ns:UserIdentityType"/>

<xs:element minOccurs="0" name="Payee" type="ns:UserIdentityType"/>

<xs:element minOccurs="0" name="PaymentTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="PaymentAmount" type="ns:AmountType"/>

<xs:element minOccurs="0" name="ReferenceID" type="ns:TransactionReferenceType"/>

<xs:element minOccurs="0" name="FeeOrCreditAmount" type="ns:AmountType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentReferenceID" type="ns:TransactionReferenceType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 9/9)

ns:FeeOrCreditAmount

Type:

ns:AmountType, simple content

Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

Component Diagram

XML Representation Summary

<ns:FeeOrCreditAmount

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:FeeOrCreditAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="FeeOrCreditAmount" type="ns:AmountType"/>

ns:Payee

Type:

ns:UserIdentityType, simple content

The person or organization who is to receive the payment allocation.

Component Diagram

XML Representation Summary

<ns:Payee

type

("eBayUser" | "eBayPartner" | "CustomCode")

Content:

{ xs:string }

</ns:Payee>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Payee" type="ns:UserIdentityType"/>

ns:Payer

Type:

ns:UserIdentityType, simple content

This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.

Component Diagram

XML Representation Summary

<ns:Payer

type

("eBayUser" | "eBayPartner" | "CustomCode")

Content:

{ xs:string }

</ns:Payer>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Payer" type="ns:UserIdentityType"/>

ns:PaymentAmount

Type:

ns:AmountType, simple content

The amount of the payment that is allocated to the payee.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the PaymentAmount value (if the corresponding monetary transaction is buyer payment for an order). To determine if 'Collect and Remit' taxes were added into PaymentAmount value, the user can check for the Transaction.eBayCollectAndRemitTaxes.TaxDetails and the Transaction.Taxes.TaxDetails containers in the response. If both of these containers appear in the response with a TaxDetails.TaxDescription value of SalesTax (in US) or GST (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.

Component Diagram

XML Representation Summary

<ns:PaymentAmount

currencyID

Content:

{ xs:double }

</ns:PaymentAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PaymentAmount" type="ns:AmountType"/>

ns:PaymentReferenceID

Type:

ns:TransactionReferenceType, simple content

The payment transaction ID.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Component Diagram

XML Representation Summary

<ns:PaymentReferenceID

type

("ExternalTransactionID" | "MandateReferenceNumber" | "CustomCode")

Content:

{ xs:string }

</ns:PaymentReferenceID>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentReferenceID" type="ns:TransactionReferenceType"/>

ns:PaymentStatus

Type:

ns:PaymentTransactionStatusCodeType, simple content

The current status of a buyer payment that is allocated to a specified payee.

XML Representation Summary

<ns:PaymentStatus>

Content:

{ enumeration of xs:token }

</ns:PaymentStatus>

Simple Content

Enumeration:

"Failed"	-	This value indicates that the payment transaction failed.
"Succeeded"	-	This value indicates that the payment transaction succeeded. If the payment transaction is a buyer's payment for an order, once this `Succeeded` value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the `Succeeded` value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the `Pending` value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from `Pending` to `Succeeded`.
"Pending"	-	This value indicates that the payment transaction is pending. Note: Previously, the `Succeeded` value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the `Pending` value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from `Pending` to `Succeeded`.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PaymentStatus" type="ns:PaymentTransactionStatusCodeType"/>

ns:PaymentTime

Type:

xs:dateTime, predefined, simple content

The date and time when the payment is received by the payee.

XML Representation Summary

<ns:PaymentTime>

Content:

{ xs:dateTime }

</ns:PaymentTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PaymentTime" type="xs:dateTime"/>

ns:ReferenceID

Type:

ns:TransactionReferenceType, simple content

A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Component Diagram

XML Representation Summary

<ns:ReferenceID

type

("ExternalTransactionID" | "MandateReferenceNumber" | "CustomCode")

Content:

{ xs:string }

</ns:ReferenceID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ReferenceID" type="ns:TransactionReferenceType"/>

{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.