Creating a Subscription method

For many gateways, it is not possible to realize a referenced transaction using a transaction ID from operations that have already been completed. In this case, there is a need for a work-around. Many of these gateways offer account management APIs which can be used afterwards for payments.

Therefore, a new method that handles the account creation must be added to the payment plug-in class.

• This function will be called from the AuthorizePayment class method, but only if the Authorize call was successful.
• It is useless to create a subscription including all the details if the payment operation has failed.
• After calling the subscription method from within the AuthorizePayment class method, if the subscription was a success, the SubscriptionID value that is returned by this method must be given a returned unique token that identifies the newly created subscription.
• Considering this, the RecurringPayment class method will be made using this SubscriptionID .

Commonly Utilized Plug-in methods

For each plug-in there must be some common methods for returning errors, finding the plug-in's root folder or storing its common elements.

<?php 
	class OnlinePaymentInterface {
	
		const method_preauth
		const method_processauth
		const method_auth
		const method_capture
		const method_refund
		const method_partial_refund
		const method_recurrent
		const method_subscribe
		
		public function LoadLanguagePack()
		
		public function GetPaymentPluginRoot()
		
		public function GetPluginParams()
		
		public function Translate(string $lp_key)
		
		public function RaiseError($code = '', $message = '', $location = ERR_PLUGIN_API, $severity = E_USER_ERROR)
		
		protected function ErrorAttachLogs($request, $response = null)
		
	}	
?>

OnlinePaymentInterface::method_*

This method constants are used to specify the output for the payment plug-in class methods. The output will be further used by 4PSA VoipNow Automation store in order to log the transaction or to display the details to the client.

OnlinePaymentInterface::LoadLanguagePack

This function is used to load the language pack for the plug-in.

OnlinePaymentInterface::GetPaymentPluginRoot

This function will return the plug-in root folder needed for loading auxiliary files. e.g. the required fields file.

OnlinePaymentInterface::GetPluginParams

OnlinePaymentInterface::Translate

This function is used for translating the language keys from the language packs.

<?php 
	self::Translate('language_key');
?>

OnlinePaymentInterface::RaiseError

This function is used for returning an error. The function's parameters will offer a code for each error, a message explaining what was wrong, a location for where the error occurred (inside the plug-in - ERR_PLUGIN_API, inside the handler - ERROR_PLUGIN_HANLDER or it ca be a custom location - ERROR_PLUGIN_CUSTOM) and a severity level (the severity level is defined with the help of the PHP error predefined constants).

OnlinePaymentInterface::ErrorAttachLogs

This function will help the developer attach the function's inputs and outputs of each method (it is mandatory for the two parameters to have the same form that they are sent and received to and from the gateway) to the error message. This method will always be used before

OnlinePaymentInterface::RaiseError

This function helps to build the message correctly. Without it, the error message will not contain the two elements.

Plug-in XML configure syntax

Both the setup and the requirements files use the same XML syntax, the differences between these two files being minimal. Both files contain the XML header:

<?xml version="1.0" encoding="UTF-8"?>

The root tag for both files has the pimmodule name and the attributes below.

<pimmodule name="MODULE_NAME" uid="UID" version="VERSION" type="TYPE" subtype="SUBTYPE">
		<!-- config content -->
	</pimmodule>

<fieldset langname="LANGUAGE_KEY" collapse="1">
		<field langname="pe_endpoint" param="endpoint" type="text" required="1" size="large" validate="/^(ht|f)tp(s?)\:\/\/[0-9a-z]([-.\w]*[0-9a-z])*(:(0-9)*)*(\/?)([\~a-z0-9\-\.\?\=\,\'\/\\\+&%\$#_]*)?$/i" alert="regexp=pe_error_incorect_pe_endpoint,notempty=pe_error_invalid_pe_endpoint" default="https://pluginexample.foo.ext" />
	</fieldset>

<title name="LANGUAGE_KEY" />

<fieldset langname="LANGUAGE_KEY" collapse="1">
		<!-- config content -->
	</fieldset>

alert="regexp=pe_error_incorect_pe_endpoint,notempty=pe_error_invalid_pe_endpoint"

<field langname="pe_curency_title" param="currency" type="selection_lists" size="medium" required="1"  alert="array_notempty=pe_error_invalid_pe_curency_title">		
		<lefttitle langname="pe_currency_left_title"/>	
		<leftvalue value="USD"/>
		<leftvalue value="CAD"/>
		<righttitle langname="pe_currency_right_title"/>
	</field>

<lefttitle langname="pe_currency_left_title" type="all">

<field langname="pe_select" param="selectex" type="select" required="1" size="medium" alert="notempty=pe_error_invalid_pe_endpoint" default="VALUE_01" />
		<fieldvalue value="VALUE_01">
		<fieldvalue value="VALUE_02">
		<fieldvalue value="VALUE_03">
	</field>