Metadata Parameters

The metadata function allows you to define module related capabilities and settings.

Payment Gateway Modules support the following metadata configuration parameters.
NameTypeNotes
DisplayNameStringAn alternate display name that will be used instead of the filename if defined
APIVersionString Defines API Version the module uses. Use 1.1 unless you have a need specific to use 1.0
gatewayTypeStringThis should be set to ‘Bank’ if the module is a Bank module, or the metadata should be omitted.
DisableLocalCredtCardInputbooltrue/false for Disable Local Credit Card Input Storage
TokenisedStoragebooltrue/false for Tokenised Storage
failedEmailStringThe name of an email template to send should a payment capture fail
successEmailStringThe name of an email template to send should a payment capture be successful
pendingEmailStringThe name of an email template to send should a payment capture be pending
LogoUrlStringGateway Logo URL

Example

<?php
function yourmodulename_MetaData()
{
    return [
        "DisplayName"=>"Your Module Name",
        "gatewayType"=>"Bank", // Only set if the module is a Bank Module
        "APIVersion"=>"1.0", // Use API Version 1.0
        "failedEmail"=>"Credit Card Payment Failed",
        "successEmail"=>"Custom Credit Card Payment Template", // You can utilise custom templates here
        "pendingEmail"=>"Custom Credit Card Pending Template",
    ];
}