getMerchantSummary
- Description
- Syntax
- Arguments
- Return Value
- Examples
  - PHP

getMerchantSummary

Reseller only method.

View summary of merchant activity.

Description

This method allows you to view a summary of a specific merchant's activity during a specified time period. The start and end dates that you set for the search are inclusive.

Use the MerchantID (unique merchant identification assigned by the gateway) to fine the merchant whose activity you would like to view.

Activity included in the search results include details about the number of sales, credits, voids, declines, errors, checks and check refunds.

Syntax

MerchantSummaryObject getMerchantSummary ( ueSecurityToken Token, integer MerchantID, string Start, string End )

Arguments

Type	Name	Description
ueSecurityToken	Token	Reseller security token: used to identify reseller and validate request.
integer	MerchantID	Merchant ID number assigned by the gateway to an active merchant.
string	Start	Date for start of summary.
string	End	Date for end of summary.

Return Value

MerchantSummaryObject

Returns summary of merchant activity for specified time period.

Examples

PHP

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

<?php>
 
try { 
 
  $MerchantID=2; 
  $StartDate='2007-01-01'; 
  $EndDate='2007-01-31'; 
 
  $res=$client->getMerchantSummary($restoken, $MerchantID, $StartDate, $EndDate); 
 
  $this->assertEquals($res->MerchantID, $MerchantID); 
 
  $this->assertTrue($res->SalesCount>1); 
 
} 
 
catch (SoapFault $e) { 
  echo $client->__getLastRequest(); 
  echo $client->__getLastResponse(); 
  die("getMerchant failed: " .$e->getMessage()); 
} 
 
?>