eBay Merchant Data APIVersion 1161

PaymentTransactionType

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

Type that uses PaymentTransactionType:

Call that uses PaymentTransactionType:

Fields



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

The person or organization who is to receive the payment allocation.
See the Field Index to learn which calls use Payee.

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

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

PaymentReferenceID ( TransactionReferenceType (string) ) [0..*]
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.
See the Field Index to learn which calls use PaymentReferenceID.

The current status of a buyer payment that is allocated to a specified payee.
See the Field Index to learn which calls use PaymentStatus.

PaymentTime ( dateTime ) [0..1]
The date and time when the payment is received by the payee.
See the Field Index to learn which calls use PaymentTime.

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