Docs For Class stormpay

Description

Stormpay class to perform the majority of functions including ipn response handling

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.stormpay.inc.php (line 23)

Variable Summary

mixed $currencies_accepted

mixed $error_email

mixed $stormpay_post_vars

mixed $stormpay_response

Method Summary

array stormpay ([array $stormpay_post_vars = array()])

nothing error_out (string $text)

string get_payment_status ()

string get_transaction_amount ()

string get_transaction_id ()

bool is_verified ()

string print_direct_payment_form ([string $amount = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $customencrypted = ''], [string $returnurl = ''])

string print_payment_form ([integer $userid = 0], [string $payer_email = ''], [string $amount = 0], [integer $invoiceid = 0], [integer $subscriptionid = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $passphrase = ''], [string $customencrypted = ''], [bool $testmode = 0])

string print_recurring_payment_form ([string $payer_email = ''], [string $amount = 0], [string $units = ''], [integer $length = 0], [string $title = ''], [string $description = ''], [string $currency = ''], [ $customencrypted = ''], [ $onsubmit = ''])

Variables

mixed $currencies_accepted = array('USD', 'GBP', 'EUR', 'CAD') (line 28)

mixed $error_email (line 27)

mixed $stormpay_post_vars = array() (line 25)

mixed $stormpay_response (line 26)

Methods

Constructor stormpay (line 37)

Function for parsing incoming variables from the payment gateway

array stormpay ([array $stormpay_post_vars = array()])

array $stormpay_post_vars: posted stormpay keys and values

error_out (line 217)

Function for sending any error emails from the process to the administrator.

nothing error_out (string $text)

string $text: error message text

get_payment_status (line 185)

Function for storing the processed payment status for later retrevial.

return: payment status

string get_payment_status ()

get_transaction_amount (line 205)

Function for storing the processed payment transaction amount for later retrevial.

return: transaction id

string get_transaction_amount ()

get_transaction_id (line 195)

Function for storing the processed payment transaction id for later retrevial.

return: transaction id

string get_transaction_id ()

is_verified (line 158)

Function for determining (internally) if the processed transaction has been verified (true or false)

return: true or false

bool is_verified ()

print_direct_payment_form (line 98)

Function for printing the payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

string print_direct_payment_form ([string $amount = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $customencrypted = ''], [string $returnurl = ''])

string $amount: amount to process
string $description: transaction description
string $merchantid: sellers payment email
string $currency: master currency
string $customencrypted: custom generated payment repsonse arguments to be decrypted by ilance payment processor
string $returnurl: return url

print_payment_form (line 66)

Function for printing the payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

string print_payment_form ([integer $userid = 0], [string $payer_email = ''], [string $amount = 0], [integer $invoiceid = 0], [integer $subscriptionid = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $passphrase = ''], [string $customencrypted = ''], [bool $testmode = 0])

integer $userid: user id
string $payer_email: payer email address
string $amount: amount to process
integer $invoiceid: associated invoice id
integer $subscriptionid: associated subscription id
string $description: transaction description
string $merchantid: merchant id
string $currency: master currency
string $passphrase: pass phrase used in some processors (usually stored with processor also)
string $customencrypted: custom generated payment repsonse arguments to be decrypted by ilance payment processor
bool $testmode: defines if this payment form should return a test - mode parameter (if available)

print_recurring_payment_form (line 131)

Function for printing the recurring payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

string print_recurring_payment_form ([string $payer_email = ''], [string $amount = 0], [string $units = ''], [integer $length = 0], [string $title = ''], [string $description = ''], [string $currency = ''], [ $customencrypted = ''], [ $onsubmit = ''])

string $payer_email: payer email address
string $amount: amount to process
string $units: unit
integer $length: length
string $title: transaction description
string $description: gateway currency to use
string $currency: custom generated payment repsonse arguments to be decrypted by ilance payment processor
$customencrypted
$onsubmit