Running Transactions

This section explains how to use the AGMS Code Library's Transaction Class to run transactions over the Transaction API.

Transaction Class Quick Example

<?php
/**
 * A basic example of a sale transaction using the AGMS PHP Library
 **/

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

// Set up the API connection
$trans = new \AGMS\Transaction();
 
// Specify transaction parameters
$params = array(
    'transaction_type' => array('value' => 'sale'),
    'amount' => array('value' => '20.00'),
    'cc_number' => array('value' => '4111111111111111'),
    'cc_exp_date' => array('value' => '1220'),
);

// Execute the transaction using the defined parameters
$result = $trans->process($params);

?>

/**
 * A basic example of a sale transaction using the AGMS Ruby Library
 **/

// Include the library
require 'agms'

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

// Set up the API connection
trans = Agms::Transaction.new

// Specify transaction parameters
params = {
    :transaction_type => { :value => 'sale'},
    :amount => { :value => '20.00'},
    :cc_number => { :value => '4111111111111111'},
    :cc_exp_date => { :value => '0520'},
    :cc_cvv => { :value => '123'}
}

// Execute the transaction using the defined parameters
result = trans.process(params)

/**
 * A basic example of a sale transaction using the AGMS Python Library
 **/

// Include the library
import 'agms'

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

// Set up the API connection
trans = agms.Transaction()

// Specify transaction parameters
params = {
    'transaction_type': {'value': 'sale'},
    'amount': {'value': '20.00'},
    'cc_number': {'value': '4111111111111111'},
    'cc_exp_date': {'value': '0520'},
    'cc_cvv': {'value': '123'}
}

// Execute the transaction using the defined parameters
result = trans.process(params)

#ucase("Coldfusion example here")#

Transaction Class: Constructor

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

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

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

The Transaction 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.

Transaction Class: process Method

// AGMS Transaction Class process() method
public array \AGMS\Transaction::process ( array $parameters )

// AGMS Transaction Class process() method
Transaction::process ( Hash parameters )

// AGMS Transaction Class process() method
Transaction.process ( dict parameters )

The AGMS Transaction object has a single method "process" which executes a single transaction according to the parameters set. The type of transaction (sale, refund, etc) is determined by the transaction_type parameter.

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 Transaction Class, each field will only have a "value" and no other options.