updateSubscriberPaymentMethod

Sent by eBay when a subscriber's payment method has changed.

A payment method is either manual or automatic. If the payment method is manual, the subscriber doesn't have a recurring payment method set up. If the payment method is automatic, the subscriber has a recurring payment method set up (currently, only PayPal is available).

For example, a payment method can become manual upon cancellation of a pre-approval agreement. Or, a payment method can become manual when PayPal sets a subscriber's payment method to manual after a problem collecting payment from the account (e.g. due to an expired pre-approval agreement or a PayPal restriction on the account).

The updateSubscriberPaymentMethod request specifies true in the manualPayment field if the payment method has been changed to manual. Otherwise it is false. If the payment method has been changed to manual, the reason field can be PAYPAL_USER_AGREEMENT_CANCELED, PAYPAL_HARD_DECLINED, INVALID, or NONE.



Back to top

Input Output Samples Change History User Notes
updateSubscriberPaymentMethod Input

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.

<?xml version="1.0" encoding="utf-8"?>
<updateSubscriberPaymentMethodRequest xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Input Fields -->
  <credentials appId="string" appId="string"> OpeneBayRequestCredentialsType (OpeneBayPrincipalIdentifierType)
    <token type="OpeneBayTokenType"> OpeneBaySecurityTokenType (OpeneBayBaseSecurityTokenType)
      <signature> string </signature>
      <tokenValue> string </tokenValue>
    </token>
  </credentials>
  <!-- Call-specific Input Fields -->
  <manualPayment> boolean </manualPayment>
  <reason> string </reason>
</updateSubscriberPaymentMethodRequest>
Argument Type Occurrence Meaning
Standard Input Fields   [Jump to call-specific fields]
credentials OpeneBayRequestCredentialsType (OpeneBayPrincipalIdentifierType) Required Container for signature and tokenValue.
credentials
  [ attribute appId ]		 string Required The AppID of the receiving application. When you upload a deployment descriptor for your application, you provide a value (as myapp.mycompany.com) that becomes your AppID in the keys that are issued for your application. For information about uploading a deployment descriptor, see the Users Guide.
credentials
  [ attribute appId ]		 string Required The AppID of the receiving application. When you upload a deployment descriptor for your application, you provide a value (as myapp.mycompany.com) that becomes your AppID in the keys that are issued for your application. For information about uploading a deployment descriptor, see the Users Guide.
credentials.token OpeneBaySecurityTokenType (OpeneBayBaseSecurityTokenType) Required Container for signature and tokenValue.
credentials.token
  [ attribute type ]		 OpeneBayTokenType Required The base type for tokens.

For a list of possible enumeration values, see OpeneBayTokenType.
credentials.token.signature string Required An RSA-encrypted string by which you can verify that the request is from eBay. You decrypt this string with the public eBay key. For more information, and the location of the public key, see the link below.

See User Guide for instructions on using this field.
credentials.token.tokenValue string Required A base64-encoded string that you must decrypt before extracting values. In the case of addSubscriber, the values that you extract include the following for the user to be added as a subscriber to your application: the user name and the user Auth token (that is, the Auth and Auth token used in the Trading API). In the case of removeSubscriber, values that you extract (for the user to remove) include the user name.
Max length: 2000.

See User Guide for values contained in tokenValue, and instructions on decrypting and parsing tokenValue.
Call-specific Input Fields
manualPayment boolean Required A payment method is either manual or automatic. If true, indicates that there is no longer a recurring payment method. If false, indicates that a recurring payment method (currently, only PayPal) is set up for the subscriber. If the payment method is manual, the subscriber doesn't have a recurring payment method set up. If the payment method is automatic, the subscriber has a recurring payment method set up (currently, only PayPal is available).
reason string Required The reason for the change in payment method. If the payment method has been changed to manual, the reason field can be PAYPAL_USER_AGREEMENT_CANCELED, PAYPAL_HARD_DECLINED, INVALID, or NONE.



Back to top

Input Output Samples Change History User Notes
updateSubscriberPaymentMethod Output

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.

<?xml version="1.0" encoding="utf-8"?>
<updateSubscriberPaymentMethodResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValueType </ack>
  <errorMessage> string </errorMessage>
  <errorSeverity> ErrorSeverityType </errorSeverity>
  <timestamp> dateTime </timestamp>
</updateSubscriberPaymentMethodResponse>
Return Value Type Occurrence Meaning
Standard Output Fields  
ack AckValueType Always Indicates whether there are any errors or warnings associated with the processing of the request.

Applicable values:

•   Failure

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, an error is returned instead of business data.

•   PartialFailure

(out) The request that triggered the error was processed successfully but with some warnings.

•   Success

(out) The request was processed successfully, but something occurred that may affect your application or the user.

•   Warning

(out) The request that triggered the error was processed successfully but with some warnings.
errorMessage string Conditionally After you decide how your implementation of this service will define errors, you can decide whether to use this container. eBay does not inspect the value of this errorMessage field.
errorSeverity ErrorSeverityType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   Error

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

•   Warning

(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
timestamp dateTime Always The date and time the request was processed. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.



Back to top

Input Output Samples Change History User Notes
updateSubscriberPaymentMethod Samples

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

A third party application is notified that a user's payment method has been changed.

Description

eBay is notifying a third-party application that a user's payment method has changed from automatic to manual.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<updateSubscriberPaymentMethodRequest xmlns="http://www.ebay.com/marketplace/services">
  <credentials appId="your_app_id">
   <token type="Value">
       <tokenValue>token_value</tokenValue>
       <signature>signature_value</signature>
   </token>
  </credentials>
  <manualPayment>true</manualPayment>
  <reason>PAYPAL_USER_AGREEMENT_CANCELED</reason>
</updateSubscriberPaymentMethodRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<updateSubscriberPaymentMethodResponse xmlns="http://www.ebay.com/marketplace/services">
<ack>Success</ack>
<timestamp>2010-02-09T06:03:55.237-0700</timestamp>
</updateSubscriberPaymentMethodResponse>



Back to top

Input Output Samples Change History User Notes
updateSubscriberPaymentMethod Change History
Version Description
1.5.0
2010-10-13
  • (added) New call.



Back to top

Input Output Samples Change History User Notes
User-Contributed Notes
   
 
 
 

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