Note: For supported statuses please see Statuses per Method.
%Plug-in_Name%_TestConnection
Tests gateway availability with specified plug-in's config.
Input parameters: config, environment.
Returned value: result array (see Methods answer format)
Mandatory : no.
%Plug-in_Name%_GetConfig
Returns parameters to configure plug-in.
Input parameters: environment.
Returned value: array with configuration data (see configuration).
Mandatory : yes.
%Plug-in_Name%_GetSupportedCurrencies
Returns a list of currencies supported by gateway.
Input parameters: environment.
Returned value: array with currency codes.
Mandatory : no.
%Plug-in_Name%_ValidateConfig
Validates applied plug-in's configuration.
Input parameters: config.
Returned value: result array (see Methods answer format)
Mandatory : no.
%Plug-in_Name%_Is3DSecureActive
Returns STATUS=APPROVED if 3D Secure is enabled for the payment gateway.
Input parameters: config, environment.
Returned value: result array (see Methods answer format).
Mandatory : Yes if 3D Secure is supported.
%Plug-in_Name%_Redirect
Implements redirection to the payment gateway page.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, config, environment.
Returned value: result array (see Methods answer format)
Mandatory : if redirection to the gateway page is required.
%Plug-in_Name%_Sell
Implements Sell transaction with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, config, environment.
Returned value: result array (see Methods answer format)
Mandatory : yes (for the gateways that use tokenization).
%Plug-in_Name%_Auth
Implements Auth transaction with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, config, environment, previous_transaction_data (for 3D Secure completion).
Returned value: result array (see Methods answer format).
Mandatory : yes (for the gateways that use 3D Secure).
%Plug-in_Name%_Capture
Implements Capture transaction with a payment gateway.
Input parameters:ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, config, environment.
Returned value: result array (see Methods answer format).
Mandatory: yes (for the gateways that use 3D Secure).
%Plug-in_Name%_GoModal
Prepares the opening of the modal form. The form will be displayed in UI as a Javascript-based checkout.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, config, environment.
Returned value: result array (see Methods answer format)
Mandatory : yes (if the opening of a modal form is required).
%Plug-in_Name%_Refund
Implements Refund transaction with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, previous_transaction_data, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_RefundPartial
Implements partial Refund transaction with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, previous_transaction_data, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_RefundCredit
Implements the Credit transaction (a non-referenced refund transaction) with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, previous_transaction_data, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_Void
Implements Void transaction with a payment gateway.
Input parameters: ref_no, transaction_amount, currency_iso, account_info, document_info, payment_method, previous_transaction_data (including a payment operation from previous transaction), config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_CheckStatus
Checks a transaction current status on a payment gateway.
Input parameters : ref_no, previous_transaction_data, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_Callback
Processes callback data received from a payment gateway.
Input parameters: document_info, payment_method, account_info, previous_transaction_data, callback_params, transaction_amount, currency_iso, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_CanRemovePayTool
Checks whether it is possible to remove a payment method.
Input parameters: account_info, vendor_info, payment_method, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.
%Plug-in_Name%_RemovePayTool
Removes a payment method from a gateway.
Input parameters: account_info, vendor_info, payment_method, config, environment.
Returned value: result array (see Methods answer format).
Mandatory : no.