Generating HPP Links

This section explains how to use the AGMS Code Library's HPP Class to generate hosted payment page hashes and links over the HPP API.

HPP Class Quick Example

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

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

// Set up the API connection
$hpp = new \AGMS\HPP();

// Configure the payment page
$params = array(
            'transaction_type' => array('value' => 'sale'),
            'amount' => array('value' => '20.00'),
            'first_name' => array('setting' => 'required'),
            'last_name' => array('setting' => 'required'),
            'zip' => array('setting' => 'required'),
            'email' => array('setting' => 'required'),
        );

// Generate the page hash with the specified configuration
$result = $hpp->generate($params);

// Print an HTML link for testing
echo 'Example HPP link';

?>

/**
 * An example of a generating a basic HPP using the AGMS Ruby Library
 **/
// Include the library
require 'agms'

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

// Set up the API connection
hpp = Agms::HPP.new

// Configure the payment page
params = {
    :transaction_type => { :value => 'sale'},
    :amount => { :value => '20.00'},
    :first_name => {  :setting => 'required'},
    :last_name => { :setting => 'required'},
    :zip => { :setting => 'required'},
    :email => { :setting => 'required'},
    :hpp_format => { :value => '1'}
}

// Generate the page hash with the specified configuration
result = hpp.generate(params);

// Print an HTML link for testing
puts 'Example HPP link';

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

// Include the library
import 'agms'

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

// Set up the API connection
hpp = agms.HPP()

// Configure the payment page
params = {
    'transaction_type': {'value': 'sale'},
    'amount': {'value': '20.00'},
    'first_name': {'setting': 'required'},
    'last_name': {'setting': 'required'},
    'zip': {'setting': 'required'},
    'email': {'setting': 'required'},
    'hpp_format': {'value': '1'},
}

// Generate the page hash with the specified configuration
result = hpp.generate(params);

// Print an HTML link for testing
print 'Example HPP link';

// Testing what will happen if we use a lot of text in one single line which is most common in programming code
#ucase("Coldfusion example here")#

HPP Class: Constructor

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

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

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

The HPP Class can be instantiated with no parameters, or gateway credentials can be explicitly set for a transaction. If no credentials are provided, the default credentials configured in init.php will be used.

HPP Class: generate Method

// AGMS HPP Class generate() method
public array \AGMS\HPP::generate ( array $parameters )

// AGMS HPP Class generate() method
HPP::generate ( Hash parameters )

// AGMS HPP Class generate() method
Transaction.generate ( dict parameters )                        

The AGMS HPP object's "generate" method executes an API request to generate an HPP hash according to the configuration parameters provided.

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. A field can be configured with a "value", "setting", or both.

HPP Class: getLink Method

// AGMS HPP Class getLink() method
public string \AGMS\HPP::getLink ( )

// AGMS HPP Class getLink() method
HPP::getLink ( Hash parameters )

// AGMS HPPn Class get_link() method
Transaction.get_link ( dict parameters )

The AGMS HPP object's "getLink" method returns a full URL that can be used to link to the payment page using the generated hash.