developer:soap-1.4:methods:getreport

Soap API v1.4

getReport

Pull a built-in or custom report from the merchant console.

Description

This method retrieves a report from the merchant console. Any reports, including custom reports, may be retrieved. The returned data is base 64 encoded. The format of the returned data can be HTML, comma separated (cvs), or tab separated (tab).

Names of built-in reports are prefaced with “CreditCard:”, “Check:” or “Customer:”. For example, to pull “Sales by Date” for credit cards, the “Report” parameter would be set to “CreditCard:Sales by Date.”

To pull a custom credit card or check report, prefix the name with “Custom:” or “CustomCheck:” For example, to pull a custom report titled “Recurring Declines” set the “Report” parameter to “Custom:Recurring Declines.” Customer reports can only be created from within the merchant console. If none of the built-in or custom reports provide data required, see the custom search methods (ie searchTransactionsCustom) for more flexibility.

See also searchTransactionsCustom, searchCustomersCustom

Syntax

string getReport ( ueSecurityToken Token, string Report, FieldValue Options, string Format )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
string Report Name of report to retrieve.
FieldValue Options Array of FieldValue objects specifying report options such as (StartDate and EndDate)
string Format Format of returned report data. Possible values are: html, csv, or tab.

Return Value

string Returns specified report data according to parameters set in search.

Exceptions

The following exceptions (errors) are applicable to this method.

Code Message Advice
20014 Unsupported file format Valid file formats are html, csv or tab.
20028 Requested Report not found Double check the name of the report.
20029 Unable to retrieve requested report An account configuration issue was encountered while generating the report. Contact support for assistance.

Available Reports

Credit Card Reports
creditcard:errors by date Credit card transactions resulting in errors, sorted by date
creditcard:errors by source Credit card transactions resulting in errors, sorted by source key
creditcard:errors by reason Credit card transactions resulting in errors, sorted by reason
creditcard:errors by user Credit card transactions resulting in errors, sorted by user
creditcard:declines by date Credit card transactions resulting in declines, sorted by date
creditcard:declines by source Credit card transactions resulting in declines, sorted by source key
creditcard:declines by reason Credit card transactions resulting in declines, sorted by reason
creditcard:declines by user Credit card transactions resulting in declines, sorted by user
creditcard:sales by date Credit card transactions resulting in approval, sorted by date
creditcard:sales by source Credit card transactions resulting in approval, sorted by source key
creditcard:sales by reason Credit card transactions resulting in approval, sorted by reason
creditcard:sales by user Credit card transactions resulting in approval, sorted by user
Check Reports
check:Deposit Report Check transactions sorted by estimated deposit date
check:All Transactions by DateAll Check transactions sorted by date (does not include errors)
check:settled by dateCheck transactions that have been marked as settled, sorted by date
check:settled by sourceCheck transactions that have been marked as settled, sorted by source
check:settled by usersCheck transactions that have been marked as settled, sorted by user
check:returns by dateCheck transactions that have been marked as returned, sorted by date
check:returns by sourceCheck transactions that have been marked as returned, sorted by source
check:returns by reasonCheck transactions that have been marked as returned, sorted by reason
check:returns by userCheck transactions that have been marked as returned, sorted by user
check:declines by dateCheck transactions were rejected by check processor, sorted by date
check:declines by sourceCheck transactions were rejected by check processor, sorted by sourcekey
check:declines by reasonCheck transactions were rejected by check processor, sorted by reason
check:declines by userCheck transactions were rejected by check processor, sorted by user
Customer Reports
customer:Pending Billing by Date Customers that are pending for recurring billing, sorted by next bill date
customer:Pending Billing by Source Customers that are pending for recurring billing, sorted by Source
customer:Billing History by Date Transactions results for recurring billing, sorted by billing date
customer:Billing History by Source Transactions results for recurring billing, sorted by Source
customer:Expired Cards Customers who have an expired credit card on file
customer:Expiring before Next Billing Customers that have a credit card that will expire before the next payment is scheduled to run
customer:Expiring by Date Range Customers that have a credit card expiring in the future

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php 
 
try { 
 
  $Options = array(
    array('Field'=>'StartDate', 'Value'=>'2007/01/01'),
    array('Field'=>'EndDate', 'Value'=>'2007/04/01')
  );
  $Format='csv';
  $Report='CreditCard:Errors By Date';
 
  $res=$client->getReport($token, $Report, $Options, $Format);  
  $data=base64_decode($res);
  print_r($data); 
 
} 
 
catch (SoapFault $e) { 
  die("Get Transaction failed :" .$e->getMessage()); 
  } 
 
?> 

.NET VB

Dim report As String
        report = "creditcard:errors by date"
        Dim options(0 To 1) As usaepay.FieldValue
        options(0) = New usaepay.FieldValue
        options(1) = New usaepay.FieldValue
        options(0).Field = "StartDate"
        options(0).Value = "2010-08-01"
        options(1).Field = "EndDate"
        options(1).Value = "2010-08-16"
 
        Dim format As String
        format = "csv"
        Dim response As String
 
        response = client.getReport(token, report, options, format)
        Dim binary_data As Byte() = Convert.FromBase64String(response)
 
 
        MsgBox(System.Text.Encoding.UTF8.GetString(binary_data))

.NET C#

            string report = "creditcard:errors by date ";
 
            usaepay.FieldValue[] options = new usaepay.FieldValue[2];
            for (int i = 0; i < 2; i++)
            {
                options[i] = new usaepay.FieldValue();
            }
 
            options[0].Field = "StartDate"; options[0].Value = "2010-08-01";
            options[1].Field = "EndDate";   options[1].Value = "2010-08-16";
 
            string format = "csv";
 
            string response;
 
            try
                {
                   response = client.getReport(token, report, options, format);
                   Byte[] binaryData = new Byte[3];
                   binaryData = Convert.FromBase64String(response);
 
                   MessageBox.Show(Encoding.UTF8.GetString(binaryData));
 
                }
                catch (Exception err)
                {
                    MessageBox.Show(err.Message);
                }

Change History

Version Change
1.3 Method added in this release
developer/soap-1.4/methods/getreport.txt · Last modified: 2013/10/21 12:53 by charlie

Page Tools