eBay Trading API Call Reference Version 643 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Trading API Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for ReviseCheckoutStatus

Use this call to update the payment details and status of a transaction or order. ReviseCheckoutStatus should be called with payment details once the buyer has completed the checkout flow and pays for the item on a Third Party site, other than PayPal. (If the buyer pays via PayPal, see Notes for Third-Party Checkout Providers.

Sellers might want to update the payment status of an item if one of the following occurs:

• The buyer made a payment via a Third-Party Checkout Provider.
• The payment from the buyer failed, and the payment method was something other than an eBay/PayPal payment.

If ReviseCheckoutStatus is called more than once for the same transaction or order (such as when checkout is marked as completed and later revised to incomplete), later calls only change values for arguments that are specified in the call. If any optional argument is not specified in the call, the value to which it corresponds is not changed from its original value.

For Third-Party Checkout Providers, a transaction is uniquely identified by one of two means:

• A TransactionID and an ItemID (this is the preferred approach).
• A BuyerID and an ItemID where eBay can identify a single transaction for the combination of the two. (If eBay identifies more than a single transaction that fits the combination, it returns an error.)

Note that if you provide all three (TransactionID, ItemID, and BuyerID), eBay ignores the BuyerID.

Notes for Third-Party Checkout Providers

Third-Party Checkout is described in the topic Third Party Checkout.

• To use ReviseCheckoutStatus, the caller must be the associated item's seller.
• ReviseCheckoutStatus is used at the end of a custom, third-party checkout process when the payment method the buyer selects during that checkout process is other than PayPal. This call updates the details and status of a transaction's checkout process in the eBay database for that transaction.
• When the buyer selects PayPal as the payment method, the Third-Party Checkout Provider application should not call ReviseCheckoutStatus. Instead, after it finishes its own processes, it should provide the buyer with a link to PayPal. There, the buyer can pay and complete the checkout process.

Testing ReviseCheckoutStatus

You can test ReviseCheckoutStatus in the Sandbox as follows:

1. Create a listing using a call such as AddItem. For ease of testing, create a listing that uses the "Buy It Now" option.
2. With a user other than the one who listed the item, buy the item.
3. Call ReviseCheckoutStatus using a combination of the ItemID and TransactionID returned from the previous calls, and supply a value for AmountPaid that is different from the amount paid with the Buy It Now option.

Related Information

See:
    Third Party Checkout
    Checkout
    Working with Combined Payment

See also the reference documentation for these calls:

• ReviseItem - Enables a seller to change the properties of a currently active listing.

Back to top

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <InvocationID> UUIDType (string) </InvocationID>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
  <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid>
  <BuyerID> string </BuyerID>
  <CheckoutMethod> CheckoutMethodCodeType </CheckoutMethod>
  <CheckoutStatus> CompleteStatusCodeType </CheckoutStatus>
  <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
  <EncryptedID> string </EncryptedID>
  <ExternalTransaction> ExternalTransactionType 
    <ExternalTransactionID> string </ExternalTransactionID>
    <ExternalTransactionTime> dateTime </ExternalTransactionTime>
  </ExternalTransaction>
  <InsuranceType> InsuranceSelectedCodeType </InsuranceType>
  <ItemID> ItemIDType (string) </ItemID>
  <MultipleSellerPaymentID> string </MultipleSellerPaymentID>
  <OrderID> string </OrderID>
  <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
  <PaymentStatus> RCSPaymentStatusCodeType </PaymentStatus>
  <SalesTax currencyID="CurrencyCodeType"> AmountType (double) </SalesTax>
  <ShippingAddress> AddressType 
  </ShippingAddress>
  <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
  <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
  <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
  <ShippingService> token </ShippingService>
  <TransactionID> string </TransactionID>
</ReviseCheckoutStatusRequest>

Back to top

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <DuplicateInvocationDetails> DuplicateInvocationDetailsType 
    <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID>
    <InvocationTrackingID> string </InvocationTrackingID>
    <Status> InvocationStatusType </Status>
  </DuplicateInvocationDetails>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</ReviseCheckoutStatusResponse>

Back to top

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Back to top

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for ReviseCheckoutStatus.

Back to top

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

© 2005–2009 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.