developer:soap-1.6:methods:gettransactionreport

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:methods:gettransactionreport [2012/08/04 10:09] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​====== getTransactionReport ======
  
 +Pull a transaction report.
 +
 +===== 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 either "​CreditCard:"​ or "​Check:"​ 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."​
 +
 +See also [[getTransactionStatus]],​ [[getTransactionCustom]],​ [[searchTransactions]],​ [[searchTransactionsCustom]],​ [[getTransaction]] ​
 +
 +===== Syntax =====
 +
 +string **getTransactionReport** ( [[..:​objects:​ueSecurityToken]] Token, string StartDate, string EndDate, string Report, string Format ) 
 +
 +
 +
 +===== Arguments =====
 +
 +^Type   ​^Name ​  ​^Description ​  ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and validate transaction.|
 +|string |StartDate |The earliest report date to retrieve.|
 +|string |EndDate |The latest report date to retrieve.|
 +|string |Report |Name of report to retrieve.|
 +|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. |
 +
 +
 +===== 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 Date|All Check transactions sorted by date (does not include errors) |
 +|check:​settled by date|Check transactions that have been marked as settled, sorted by date |
 +|check:​settled by source|Check transactions that have been marked as settled, sorted by source |
 +|check:​settled by users|Check transactions that have been marked as settled, sorted by user |
 +|check:​returns by date|Check transactions that have been marked as returned, sorted by date |
 +|check:​returns by source|Check transactions that have been marked as returned, sorted by source |
 +|check:​returns by reason|Check transactions that have been marked as returned, sorted by reason |
 +|check:​returns by user|Check transactions that have been marked as returned, sorted by user |
 +|check:​declines by date|Check transactions were rejected by check processor, sorted by date |
 +|check:​declines by source|Check transactions were rejected by check processor, sorted by sourcekey |
 +|check:​declines by reason|Check transactions were rejected by check processor, sorted by reason |
 +|check:​declines by user|Check transactions were rejected by check processor, sorted by user |
 +
 +
 +
 +===== Examples =====
 +
 +==== PHP ====
 +
 +For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[..:​howto:​php|PHP Soap How-to]].
 +
 +<code php>
 +<?​php ​
 +
 +try { 
 +
 +  $StartDate='​2007/​01/​01'; ​
 +  $EndDate='​2007/​04/​10'; ​
 +  $Format='​csv';​
 +  $Report='​CreditCard:​Errors By Date';
 +
 +  $res=$client->​getTransactionReport($token,​ $StartDate, $EndDate, $Report, $Format);  ​
 +  $data=base64_decode($res);​
 +  print_r($data); ​
 +             
 +
 +
 +catch (SoapFault $e) { 
 +  die("​Get Transaction failed :" .$e->​getMessage()); ​
 +  } 
 +
 +?> 
 +</​code>​
 +
 +
 +==== Java ====
 +
 +This example uses the [[developer/​javalibrary|USAePay Java library]]. ​ For directions on how to install the library and create the token/​client objects, go to either the [[..:​howto:​javajaxrpc|Java JAX-RPC Howto]] or the [[..:​howto:​javajaxws|Java JAX-WS Howto]].
 +
 +<code java>
 +try {
 +  String StartDate = "​2009/​01/​01";​
 +  String EndDate = "​2009/​09/​09";​
 +  String Format = "​html";​
 +  String Report = "​CreditCard:​Errors By Date";
 +
 +  String response = client.getTransactionReport(token,​ StartDate, EndDate, Report, Format);
 + 
 +  BASE64Decoder decoder = new BASE64Decoder();​
 +  byte[] decodedBytes = decoder.decodeBuffer(response);​
 +
 +  String report = new String(decodedBytes);​
 +  System.out.println(report); ​
 +} catch (Exception e) {
 +    System.out.println("​Soap Exception: " + e.getMessage());​
 +}
 +</​code>​
 +
 +==== .NET VB ====
 +<code vb>
 +Dim start As String
 +        start = "​2010-08-01"​
 +        Dim endd As String
 +        endd = "​2010-08-09"​
 +        Dim format As String
 +        format = "​html"​
 +        Dim report As String
 +        report = "​CreditCard:​Sales By Date"
 +
 +        Dim response As String
 +        response = client.getTransactionReport(token,​ start, endd, report, format)
 +        Dim decbuff() As Byte
 +        decbuff = Convert.FromBase64String(response)
 +        MsgBox(Encoding.UTF8.GetString(decbuff))
 +</​code>​
 +
 +==== .NET C# ====
 +For directions on how to set up the WSDL link and create the "​token"​ and "​client"​ variables, go to the [[..:​howto:​csharp|C Sharp .Net Soap How-to]].
 +<code c>
 +string start = "​2010-08-01";​
 +            string end = "​2010-08-09";​
 +            string format = "​html";​
 +            string report = "​CreditCard:​Sales By Date";
 +
 +            try
 +            {
 +                string response = client.getTransactionReport(token,​ start, end, report, format);
 +                byte[] decbuff = Convert.FromBase64String(response);​
 +                MessageBox.Show(Encoding.UTF8.GetString(decbuff));​
 +            }
 +
 +            catch (Exception err)
 +            {
 +                MessageBox.Show(err.Message);​
 +            }
 +</​code>​
 +
 +
 +===== Change History =====
 +
 +^ Version ^ Change ^
 +| [[developer:​soap-1.1:​methods:​gettransactionreport|1.1]] | Method added prior to soap-1.1 |
developer/soap-1.6/methods/gettransactionreport.txt ยท Last modified: 2012/08/04 10:09 by tem

Page Tools