addCredit

This call is reserved for future use.



Back to top

Input Output Samples Change History User Notes
addCredit 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"?>
<addCreditRequest xmlns="http://www.ebay.com/marketplace/services">
  <amount2> Amount (double) </amount2>
  <billingAccountId> string </billingAccountId>
  <creditAmount> Amount (double) </creditAmount>
  <creditDescription> string </creditDescription>
  <creditReason> OpeneBayCreditReasonType </creditReason>
  <creditTime> dateTime </creditTime>
  <externalCreditId> string </externalCreditId>
  <planId> long </planId>
  <recordDescription> string </recordDescription>
  <recordId> string </recordId>
  <recordTime> dateTime </recordTime>
  <recordType> OpeneBayBillingRecordTypeType </recordType>
  <statementId> string </statementId>
  <subscriptionId> long </subscriptionId>
  <userName> string </userName>
</addCreditRequest>
Argument Type Occurrence Meaning
amount2 Amount (double) Required The recordType determines what this value signifies. Returned in the getBillingRecords response. eBay uses this value to ensure that the credit is matched to the correct original charge.

If recordType is Subscription, amount2 represents the subscription amount, in the billing currency, against which the credit is to be applied.

If recordType is OneTimeCharge, amount2 represents the charge amount, in the billing currency, against which the credit is to be applied.

If recordType is Usage, amount2 represents the amount of the usage charge, in the billing currency, against which the credit is to be applied.

If recordType is Statement, amount2 represents the statement total, in the billing currency, against which the credit is to be applied.
billingAccountId string Required A unique identifier for each combination of an application and a subscriber.
Max length: 32.
creditAmount Amount (double) Required Amount to be credited to the subscriber. The amount is in the billing currency (the currency specified in the original charge).
creditDescription string Required Describes the credit applied to the subscriber's account.
Max length: 1024.
creditReason OpeneBayCreditReasonType Required Explains why the credit has been applied to the subscriber's account.

Applicable values:

•   StatementCredit

(in/out) Explains why the credit has been applied to the subscriber's account.
creditTime dateTime Required The date assigned to the credit request by the application.
externalCreditId string Required A transaction reference number that you can assign to the credit. This number will be returned in the getCredit response.
planId long Required A planId is assigned by eBay to each subscription plan. Your application often uses this value in calls to the Open eBay Application Integration Service. Note that the planId is diffrent from the externalPlanId. In contrast to the planId, the externalPlanId is the value that you provide, as a "Developer Plan ID," when you create a subscription plan.
recordDescription string Optional The recordType determines what this value signifies. Returned in the getBillingRecords response.

If recordType is Subscription, recordDescription contains a text description of the subscription.

If recordType is OneTimeCharge, recordDescription contains a text description of the charge.

If recordType is Usage, recordDescription contains a text description of the usage.

If recordType is Statement, recordDescription contains a text description of the statement.
recordId string Required Unique identifier for the record, assigned by eBay. Contains state and location information about the record. An example of a recordId: 1111:222:333:444:x. Returned in the getBillingRecords response.
Max length: 256.
recordTime dateTime Required The recordType determines what this value signifies. Returned in the getBillingRecords response.

If recordType is Subscription, recordTime represents the beginning of the time range, the time from, that ends at the time to given in recordTime2.

If recordType is OneTimeCharge, recordTime represents the time of the transaction.

If recordType is Usage, recordTime represents the time of the transaction.

If recordType is Statement, recordTime represents the statement time.
recordType OpeneBayBillingRecordTypeType Required Specifies whether the record is a one-time charge, a statement, a subscription charge, or a usage charge. For these four different kinds of records, the values transmitted for other elements, such as taxAmount and recordTime, represent elements appropriate for the record type. For example, for recordTime, if the recordType is Usage then recordTime represents the transaction date; but if recordType is Statement, recordTime represents the time of the statement's creation. See the specific values in each element. Returned in the getBillingRecords response.

Applicable values:

•   OneTimeCharge

(in/out) Indicates that the current billing record represents a one-time charge.

•   Statement

(in/out) Indicates that the current billing record represents a statement.

•   SubscriptionCharge

(in/out) Indicates that the current billing record represents a charge for a subscription.

•   UsageCharge

(in/out) Indicates that the current billing record represents a usage charge.
statementId string Required Unique identifier for a billing statement, created by eBay at statement time. Returned in the getBillingRecords response.
Max length: 256.
subscriptionId long Required For a particular application, the subscriptionId uniquely identifies a user's subscription.
userName string Required The eBay user ID of the subscriber.



Back to top

Input Output Samples Change History User Notes
addCredit 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"?>
<addCreditResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <creditId> long </creditId>
</addCreditResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
ack AckValue 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, the error is returned instead of the 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 ErrorMessage Conditionally Information for an error or warning that occurred when eBay processed the request.
errorMessage.error ErrorData Conditionally,
repeatable: [0..*]		 ActivityProfile about a single error.
errorMessage.error.category ErrorCategory Conditionally There are three categories of errors: request errors, application errors, and system errors.

Applicable values:

•   Application

(out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the appilcation or data is resolved, resend the corrected request to eBay.

•   Request

(out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data.

•   System

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain string Conditionally Name of the domain upon which the error occurred.
Domains include:
Marketplace
A business or validation error occurred for the UserProfile Service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId long Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId token Conditionally Unique identifier for an exception associated with an error.
errorMessage.error.message string Conditionally A detailed description of the condition that resulted in the error.
errorMessage.error.parameter ErrorParameter (string) Conditionally,
repeatable: [0..*]		 Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter
  [ attribute name ]		 string Conditionally The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity ErrorSeverity Conditionally Indicates whether the error caused the request to fail (Error) or not (Warning).

If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

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.
errorMessage.error.subdomain string Conditionally Name of the subdomain upon which the error occurred. Subdomains include the following: UserProfile (in which the error is specific to the UserProfile service) and MarketplaceCommon (in which the error is common to all Marketplace services).
timestamp dateTime Always The date and time when eBay processed the request. 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.
version string Always Open eBay version.
Call-specific Output Fields
creditId long Conditionally Unique identifier assigned to the credit request by eBay.



Back to top

Input Output Samples Change History User Notes
addCredit 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

This call is not functional.

Description

This call is not functional.

Input

This call is not functional.

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

<?xml version="1.0" encoding="UTF-8"?>
  <addCreditRequest xmlns="http://www.ebay.com/marketplace/services">
    <!--You may enter ANY elements at this point-->
    <planId>1007</planId>
    <subscriptionId>SubscriptionID</subscriptionId>
    <userName>UserName</userName>
    <creditAmount currencyId="USD">2</creditAmount>
    <creditTime>2009-05-01</creditTime>
    <externalCreditId>bba</externalCreditId>
    <creditReason>StatementCredit</creditReason>
    <creditDescription>ddd</creditDescription>
    <billingAccountId>160000038310001</billingAccountId>
    <statementId>6782008:1</statementId>
    <recordType>SubscriptionCharge</recordType>
    <recordId>7598229:x:11:6:160009</recordId>
    <recordTime>2009-04-13</recordTime>
    <amount2 currencyId="USD">20</amount2>
    <!--Optional:-->
    <recordDescription>fff</recordDescription>
  </addCreditRequest>

Output

This call is not functional.

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

<?xml version="1.0" encoding="UTF-8"?>
   <addCreditResponse xmlns="http://www.ebay.com/marketplace/services">
      <ack>Success</ack>
      <version>1.2.0</version>
      <timestamp>2009-09-09T06:56:54.752Z</timestamp>
   </addCreditResponse>



Back to top

Input Output Samples Change History User Notes
addCredit Change History
Version Description
1.2.0
2009-09-09
  • (added) New call



Back to top

Input Output Samples Change History User Notes
User-Contributed Notes
   
 
 
 

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

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