Running Reports

This section explains how to use the AGMS Code Library's Report Class to pull reports and transaction details from various Reporting methods on the Gateway API.

Report Class Quick Example

<?php
/**
 * An example of a generating a basic Transaction Report using the AGMS PHP Library
 **/

// Include the library
require('AGMS/init.php');

// Set up the API connection
$rep = new \AGMS\Report();

// Configure the search parameters
$params = array(
            'start_date' => array('value' => '2014-09-24'),
            'end_date' => array('value' => '2015-11-09'),
        );

// Pull a list of transactions from the gateway
$report = $rep->listTransactions($params);

// Dump output for testing
var_dump($report);

?>

/**
 * An example of a generating a basic Transaction Report using the AGMS Ruby Library
 **/

// Include the library
require 'agms'

// Initialise the library configuration
Agms::Configuration.init('init.yml')

// Set up the API connection
rep = Agms::Report.new

// Configure the search parameters
params = {
    :start_date => { :value => '2015-01-01'},
    :end_date => { :value => '2015-03-28'}
}

// Pull a list of transactions from the gateway
report = rep.listTransactions(params)

// Dump output for testing
puts(report)

/**
 * An example of a generating a basic Transaction Report using the AGMS Python Library
 **/

// Include the library
import 'agms'

// Initialise the library configuration
agms.Configuration.init('init.init')

// Set up the API connection
rep = agms.Report()

// Configure the search parameters
params = {
    'start_date': {'value': '2015-03-25'},
    'end_date': {'value': '2015-03-31'},
}

// Pull a list of transactions from the gateway
report = rep.list_transactions(params)

// Dump output for testing
print(report)

#ucase("Coldfusion example here")#

Report Class: Constructor

// AGMS Report Class Constructor
public array \AGMS\Report::__construct ( [ string $username [, $password [, $accountnumber [, $apikey ] ] ] ] )

// AGMS Report Class Constructor
Report::initialise ( [ string username [, password [, accountnumber [, apikey ] ] ] ] )

// AGMS Report Class Constructor
Report.__init__( self, [ string username [, password [, accountnumber [, apikey, [client] ] ] ] ] )

The Report Class can be instantiated with no parameters, or you can explicitly set the gateway credentials you would like to be used for that transaction. If no credentials are provided, the default credentials configured in init.php will be used.

Report Class: listTransactions Method

// AGMS Report Class listTransactions() method
public array \AGMS\Report::listTransactions ( array $parameters )

// AGMS Report Class listTransactions() method
Report::process ( Hash parameters )                        

// AGMS Report Class list_transactions() method
Report.process ( dict parameters )                        

The AGMS Report object's "listTransactions" method executes an API request to search for transactions using the provided parameters and list their details.

A full listing of the Request parameters is available in the Requests tab, and a full listing of Response parameters is available in the Responses tab.

The parameter array is a two dimensional array, with each field containing an array of its configuration values. For the purposes of the Report Class, each field will only have a "value" and no other options.