Open eBay Subscription Call Reference Version 1.2.0 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

Retrieves the image of a billing statement. After you have retrieved an ID of a billing statement using getBillingStatements, you can call getBillingStatementImage to retrieve the image of the billing statement. The image is base64-encoded. The image is of a single billing statement of a user who is subscribed to your application. In your getBillingStatementImage call, you specify a subscription ID and the ID of the statement whose image you want to retrieve. Depending on the value returned in the statementImage.imageCompressionType field, your application may or may not need to uncompress the base64 data. Your application must convert the base64 data into text format. The end-result is a text file containing the HTML for the billing statement you specified in the request. If the statementImageMessage field is returned, that field will contain text about a problem that has occurred in the retrieval of the billing statement image.

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.

<?xml version="1.0" encoding="utf-8"?>
<getBillingStatementImageRequest xmlns="http://www.ebay.com/marketplace/services">
  <statementId> string </statementId>
  <subscriptionId> long </subscriptionId>
</getBillingStatementImageRequest>

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.

<?xml version="1.0" encoding="utf-8"?>
<getBillingStatementImageResponse 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 -->
  <statementImage> StatementImage
    <imageCompressionType> ImageCompressionType </imageCompressionType>
    <imageData> base64Binary </imageData>
    <imageFormat> ImageFormat </imageFormat>
  </statementImage>
  <statementImageMessage> string </statementImageMessage>
</getBillingStatementImageResponse>

Back to top

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.

Requests a billing statement image. The image is base64-encoded. The image is of a single billing statement of a user who is subscribed to your application.

Description

After you have retrieved an ID of a billing statement using getBillingStatements, you can call getBillingStatementImage to retrieve the image of the billing statement. In your getBillingStatementImage call, you must specify the ID of the statement whose image you want to retrieve, along with the subscriber's subscription ID. Your application must uncompress the base64 data and then convert the base64 data into text format. The end-result will be a text file containing the HTML for the billing statement you specified in the request.

Input

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

<?xml version="1.0" encoding="utf-8" ?>
  <getBillingStatementImageRequest xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
    <subscriptionId>5330007258</subscriptionId>
    <statementId>8420844:1</statementId>
  </getBillingStatementImageRequest>

Output

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

<?xml version="1.0" encoding="utf-8" ?>
<getBillingStatementImageResponse xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
   <ack>Success</ack>
   <version>1.1.0</version>
   <timestamp>2010-07-28T23:31:11.756Z</timestamp>
   <statementImage>
      <imageData>H4sIAAAAAAAAAO1aa....WIjAAA=</imageData>
      <imageFormat>text/html</imageFormat>
      <imageCompressionType>gzip</imageCompressionType>
   </statementImage>
</getBillingStatementImageResponse>

Back to top

Back to top

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