Public Member Functions
	__construct ($username, $password, $bgas_url, $transactions_url, $services_url)

	process ()

	getTransactionHandle ()

	_refreshAuthToken ()

	_getAuthSoapHeader ($namespace)

	_setSupportedCreditCardTypes ()

	getTransactionGstRate ()

	_getTransactionErrors ($result)

	_getTransactionInvoiceNumber ($result)

	_getTransactionDetails ($result)

	getResponse ()

	getWebserviceTransactionsURL ()

	getWebserviceServicesURL ()

	setCreditCard ($credit_card_no)

	setCreditCardCV2 ($cv2)

	setTransactionReferenceNo ($reference_no)

	setCardExpiryMonth ($month)

	setCardExpiryYear ($year)

	setCardHolderName ($card_holder_name)

	setMerchantId ($merchant_id)

	setPaymentModel ($model)

	getTransactionReferenceNo ()

	getCreditCard ()

	getCreditCardCV2 ($cv2)

	getExpiryDate ()

	getCardHolderName ()

	getMerchantId ()

	getPaymentModel ()

	setFirstName ($first_name)

	setSurname ($surname)

	setEmail ($email)

	setAddressLine1 ($address_1)

	setAddressLine2 ($address_2)

	setSuburb ($suburb)

	setCity ($suburb)

	setPostcode ($postcode)

	getFirstName ()

	getSurname ()

	getEmail ()

	getAddressLine1 ()

	getAddressLine2 ()

	getSuburb ()

	getCity ()

	getPostcode ()

	setReferenceId ($ref_id)

	setApplicationUserName ($username)

	setName ($name)

	setDescription ($description)

	setQuantity ($quantity)

	setRefundType ($refund_type)

	setRefundExpiryDate ($refund_expiry_date)

	setProductCode ($product_code)

	setFinancialCode ($financial_code)

	setFinancialValues ($financial_values)

	setAdditionalInfo ($additional_info)

	addCartItem ($application_username, $name, $description, $quantity, $refund_type, $refund_expiry_date, $amount, $product_code, $financial_code, $financial_values, $additional_info)

	clearCart ()

	getCartItems ()

	getCardExpiryMonth ($month)

	getCardExpiryYear ($year)

	getCardTypes ()

	getTestCardNumbers ()

Detailed Description

Definition at line 33 of file utransact_processor.inc.

Constructor & Destructor Documentation

__construct	(	$username,
		$password,
		$bgas_url,
		$transactions_url,
		$services_url
	)

Constructor

Parameters

string	$username	username of the UTransact account
string	$password	password of the UTransact account
string	$bgas_url	url to UTransact Bgas webservice
string	$transactions_url	url to UTransact Transactions webservice
string	$services_url	url to UTransact Services webservice

Definition at line 289 of file utransact_processor.inc.

Member Function Documentation

_getAuthSoapHeader ( $namespace )

Get PgWebServiceAuthToken (authentication token) SOAP header

$namespace Namespace to set for the SOAP header

Returns: object|boolean private

Definition at line 683 of file utransact_processor.inc.

_getTransactionDetails ( $result )

Get the transaction details from the transaction response

string $result XML content returned by webservice

Returns: Array() public

Definition at line 843 of file utransact_processor.inc.

_getTransactionErrors ( $result )

Get the error info from the transaction respose

string $result XML content returned by webservice

Returns: array private

Definition at line 793 of file utransact_processor.inc.

_getTransactionInvoiceNumber ( $result )

Get the invoice number from the transaction respose

string $result XML content returned by webservice

Returns: string private

Definition at line 822 of file utransact_processor.inc.

_refreshAuthToken ( )

Refreshes the authentication token

If existing token doesn't exist or has expired then set a new one

Returns: boolean private

Definition at line 610 of file utransact_processor.inc.

_setSupportedCreditCardTypes ( )

Setup the credit card list supported by UTransact webservice

Returns: boolean private

Definition at line 714 of file utransact_processor.inc.

addCartItem	(	$application_username,
		$name,
		$description,
		$quantity,
		$refund_type,
		$refund_expiry_date,
		$amount,
		$product_code,
		$financial_code,
		$financial_values,
		$additional_info
	)

Add the cart item to the list

Parameters

string	$application_username
string	$name
string	$description
int	$quantity
string	$refund_type
string	$refund_expiry_date
float	$amount
string	$product_code
string	$financial_code
string	$financial_values
string	$additional_info

Returns: boolean public

Definition at line 1526 of file utransact_processor.inc.

clearCart ( )

Clear the shopping cart

Returns: void public

Definition at line 1556 of file utransact_processor.inc.

getAddressLine1 ( )

Get address line 1

Returns: string public

Definition at line 1284 of file utransact_processor.inc.

getAddressLine2 ( )

Get address line 2

Returns: string public

Definition at line 1297 of file utransact_processor.inc.

getCardExpiryMonth ( $month )

Get expiry date month

Returns: string public

Definition at line 1580 of file utransact_processor.inc.

getCardExpiryYear ( $year )

Get expiry date year

Returns: string public

Definition at line 1593 of file utransact_processor.inc.

getCardHolderName ( )

Get card holder name

Returns: void public

Definition at line 1086 of file utransact_processor.inc.

getCardTypes ( )

returns array of possible card types supported by gateway

public

Returns: array

Definition at line 1606 of file utransact_processor.inc.

getCartItems ( )

Returns the cart items

Returns: boolean public

Definition at line 1568 of file utransact_processor.inc.

getCity ( )

Get city

Returns: string public

Definition at line 1323 of file utransact_processor.inc.

getCreditCard ( )

Get credit card number

Returns: string public

Definition at line 1047 of file utransact_processor.inc.

getCreditCardCV2 ( $cv2 )

Get credit card cv2 number

Returns: string public

Definition at line 1060 of file utransact_processor.inc.

getEmail ( )

Get email

Returns: string public

Definition at line 1271 of file utransact_processor.inc.

getExpiryDate ( )

Get expiry date

Returns: string public

Definition at line 1073 of file utransact_processor.inc.

getFirstName ( )

Get first name

Returns: string public

Definition at line 1245 of file utransact_processor.inc.

getMerchantId ( )

Get merchant id

Returns: int public

Definition at line 1099 of file utransact_processor.inc.

getPaymentModel ( )

Get payment model

Returns: string public

Definition at line 1112 of file utransact_processor.inc.

getPostcode ( )

Get postcode

Returns: int public

Definition at line 1336 of file utransact_processor.inc.

getResponse ( )

Returns the gateway response array in standard format

This should be the format other gateways use to return their response

public

Returns: array

Definition at line 872 of file utransact_processor.inc.

getSuburb ( )

Get suburb

Returns: string public

Definition at line 1310 of file utransact_processor.inc.

getSurname ( )

Get surname

Returns: string public

Definition at line 1258 of file utransact_processor.inc.

getTestCardNumbers ( )

Get array of valid card numbers for testing

public

Returns: array

Definition at line 1619 of file utransact_processor.inc.

getTransactionGstRate ( )

Return the GST rate set from the payment gateway

Returns: string|boolean public

Definition at line 759 of file utransact_processor.inc.

getTransactionHandle ( )

Get unique transaction handle for the transation

This transaction handle has a very short lifetime (< 2 minutes)

Returns: string|boolean public

Definition at line 569 of file utransact_processor.inc.

getTransactionReferenceNo ( )

Get transaction reference number

Returns: string public

Definition at line 1034 of file utransact_processor.inc.

getWebserviceServicesURL ( )

Get URL for UTransact services webservice

Returns: string public

Definition at line 899 of file utransact_processor.inc.

getWebserviceTransactionsURL ( )

Get URL for UTransact transactions webservice

Returns: string public

Definition at line 885 of file utransact_processor.inc.

process ( )

Process the transaction

Returns: mixed public

Definition at line 315 of file utransact_processor.inc.

setAdditionalInfo ( $additional_info )

Set financial values

Parameters

string $additional_info

Returns: void public

Definition at line 1501 of file utransact_processor.inc.

setAddressLine1 ( $address_1 )

Set address line 1

Parameters

string $first_name First name

Returns: void public

Definition at line 1172 of file utransact_processor.inc.

setAddressLine2 ( $address_2 )

Set address line 2

Parameters

string $first_name First name

Returns: void public

Definition at line 1187 of file utransact_processor.inc.

setApplicationUserName ( $username )

Set application username

Parameters

string $username

Returns: void public

Definition at line 1366 of file utransact_processor.inc.

setCardExpiryMonth ( $month )

Set expiry date month

Parameters

string $month

Returns: void public

Definition at line 961 of file utransact_processor.inc.

setCardExpiryYear ( $year )

Set expiry date year

Parameters

string $year

Returns: void public

Definition at line 976 of file utransact_processor.inc.

setCardHolderName ( $card_holder_name )

Set card holder name

Parameters

string $card_holder_name

Returns: void public

Definition at line 991 of file utransact_processor.inc.

setCity ( $suburb )

Set city

Parameters

string $first_name First name

Returns: void public

Definition at line 1217 of file utransact_processor.inc.

setCreditCard ( $credit_card_no )

Set credit card number

Parameters

string $credit_card_no

Returns: void public

Definition at line 915 of file utransact_processor.inc.

setCreditCardCV2 ( $cv2 )

Set credit card cv2 number

Parameters

string $cv2

Returns: void public

Definition at line 930 of file utransact_processor.inc.

setDescription ( $description )

Set description

Parameters

string $description

Returns: void public

Definition at line 1396 of file utransact_processor.inc.

setEmail ( $email )

Set email

Parameters

string $first_name First name

Returns: void public

Definition at line 1157 of file utransact_processor.inc.

setFinancialCode ( $financial_code )

Set financial code

Parameters

string $financial_code

Returns: void public

Definition at line 1471 of file utransact_processor.inc.

setFinancialValues ( $financial_values )

Set financial values

Parameters

string $financial_values

Returns: void public

Definition at line 1486 of file utransact_processor.inc.

setFirstName ( $first_name )

Set first name

Parameters

string $first_name First name

Returns: void public

Definition at line 1127 of file utransact_processor.inc.

setMerchantId ( $merchant_id )

Set merchant id

Parameters

int $merchant id

Returns: void public

Definition at line 1006 of file utransact_processor.inc.

setName ( $name )

Set name

Parameters

string $name

Returns: void public

Definition at line 1381 of file utransact_processor.inc.

setPaymentModel ( $model )

Set payment model

Parameters

string $model

Returns: void public

Definition at line 1021 of file utransact_processor.inc.

setPostcode ( $postcode )

Set postcode

Parameters

string $first_name First name

Returns: void public

Definition at line 1232 of file utransact_processor.inc.

setProductCode ( $product_code )

Set product code

Parameters

String $product_code

Returns: void public

Definition at line 1456 of file utransact_processor.inc.

setQuantity ( $quantity )

Set quantity

Parameters

int $quantity

Returns: void public

Definition at line 1411 of file utransact_processor.inc.

setReferenceId ( $ref_id )

Set reference id

Parameters

string $ref_id

Returns: void public

Definition at line 1351 of file utransact_processor.inc.

setRefundExpiryDate ( $refund_expiry_date )

Set refund expiry date

Parameters

string $refund_expiry_date

Returns: void public

Definition at line 1441 of file utransact_processor.inc.

setRefundType ( $refund_type )

Set refund type

Parameters

string $refund_type

Returns: void public

Definition at line 1426 of file utransact_processor.inc.

setSuburb ( $suburb )

Set suburb

Parameters

string $first_name First name

Returns: void public

Definition at line 1202 of file utransact_processor.inc.

setSurname ( $surname )

Set surname

Parameters

string $first_name First name

Returns: void public

Definition at line 1142 of file utransact_processor.inc.

setTransactionReferenceNo ( $reference_no )

Set transaction reference number

Parameters

string $reference_no

Returns: void public

Definition at line 946 of file utransact_processor.inc.

The documentation for this class was generated from the following file:

/Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/payment_gateway_types/payment_gateway_utransact/utransact_processor.inc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation