ReviseCheckoutStatusRequestType
A seller can use this call to update the payment details and status of a transaction or order.
Fields
AdjustmentAmount ( AmountType (double) )
AmountPaid ( AmountType (double) )
BuyerID ( string )
CheckoutMethod ( CheckoutMethodCodeType )
CheckoutStatus ( CompleteStatusCodeType )
CODCost ( AmountType (double) )
EncryptedID ( string )
ExternalTransaction ( ExternalTransactionType )
InsuranceType ( InsuranceSelectedCodeType )
ItemID ( ItemIDType (string) )
MultipleSellerPaymentID ( string )
OrderID ( string )
PaymentMethodUsed ( BuyerPaymentMethodCodeType )
PaymentStatus ( RCSPaymentStatusCodeType )
SalesTax ( AmountType (double) )
ShippingAddress ( AddressType )
ShippingCost ( AmountType (double) )
ShippingIncludedInTax ( boolean )
ShippingInsuranceCost ( AmountType (double) )
ShippingService ( token )
TransactionID ( string )

AdjustmentAmount ( AmountType (double) ) [0..1]
Discount or charge agreed to by the buyer and seller. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller.
See the Field Index to learn which calls use AdjustmentAmount.

AmountPaid ( AmountType (double) ) [0..1]
The total amount paid by the buyer. For a US eBay Motors item, AmountPaid is the total amount paid by the buyer for the deposit. AmountPaid is optional if CheckoutStatus is Incomplete and required if it is Complete.
See the Field Index to learn which calls use AmountPaid.

BuyerID ( string ) [0..1]
eBay ID for the buyer in the transaction being revised. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.
See the Field Index to learn which calls use BuyerID.

CheckoutMethod ( see CheckoutMethodCodeType for possible values ) [0..1]
Not supported.
See the Field Index to learn which calls use CheckoutMethod.

CheckoutStatus ( see CompleteStatusCodeType for possible values ) [0..1]
The current status of the checkout process for the transaction.
See the Field Index to learn which calls use CheckoutStatus.

CODCost ( AmountType (double) ) [0..1]
Italy site (site ID 101) only. Enables you to specify the cash-on-delivery (COD) cost, for COD shipping.
See the Field Index to learn which calls use CODCost.

EncryptedID ( string ) [0..1]
Not supported.
See the Field Index to learn which calls use EncryptedID.

ExternalTransaction ( ExternalTransactionType ) [0..1]
See the Field Index to learn which calls use ExternalTransaction.

InsuranceType ( see InsuranceSelectedCodeType for possible values ) [0..1]
The insurance option selected by the buyer.
See the Field Index to learn which calls use InsuranceType.

ItemID ( ItemIDType (string) ) [0..1]
Unique ID for the item associated with the checkout. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.
See the Field Index to learn which calls use ItemID.

MultipleSellerPaymentID ( string ) [0..1]
Not supported.
See the Field Index to learn which calls use MultipleSellerPaymentID.

OrderID ( string ) [0..1]
Unique ID for a multi-item order. If specified, ItemID and TransactionID are ignored if specified in the same call. Changes to the checkout status are applied to the specified order as a whole (and thus the child transactions associated with the order).
See the Field Index to learn which calls use OrderID.

PaymentMethodUsed ( see BuyerPaymentMethodCodeType for possible values ) [0..1]
Payment method used by the buyer. Required if CheckoutStatus is Complete. (Please note that only PayPal can set this value to PayPal.)
Note: Required or allowed payment methods vary by site and category. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify.

See the Field Index to learn which calls use PaymentMethodUsed.

PaymentStatus ( see RCSPaymentStatusCodeType for possible values ) [0..1]
Marks the transaction status as Paid or awaiting payment in My eBay. If you specify Paid, My eBay shows an icon to indicate that the transaction status is Paid. If Pending, it means the transaction is awaiting payment. (Some applications may use Pending when the buyer has paid but the funds have not yet been sent to the seller's financial institution.)
See the Field Index to learn which calls use PaymentStatus.

SalesTax ( AmountType (double) ) [0..1]
Amount of money paid for sales tax. For Third-Party Checkout applications.
See the Field Index to learn which calls use SalesTax.

ShippingAddress ( AddressType ) [0..1]
For internal use.
See the Field Index to learn which calls use ShippingAddress.

ShippingCost ( AmountType (double) ) [0..1]
Amount of money paid for shipping. For Third-party Checkout applications.
See the Field Index to learn which calls use ShippingCost.

ShippingIncludedInTax ( boolean ) [0..1]
An indicator of whether shipping costs were included in the taxable amount. For Third-Party Checkout applications.
See the Field Index to learn which calls use ShippingIncludedInTax.

ShippingInsuranceCost ( AmountType (double) ) [0..1]
Amount of money paid for insurance. For Third Party Checkout applications.
See the Field Index to learn which calls use ShippingInsuranceCost.

ShippingService ( token ) [0..1]
The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails.
See the Field Index to learn which calls use ShippingService.

TransactionID ( string ) [0..1]
Unique ID for the transaction associated with the checkout. For Chinese auctions, the value passed in the TransactionID argument must be 0 or the call will fail with an error. For all other auction types, TransactionID accepts the actual, nonzero transaction ID. Call GetItemTransactionsCall or GetSellerTransactionsCall to determine the correct transaction ID. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.
See the Field Index to learn which calls use TransactionID.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.