GetConfig

This section describes one of the fraud screening methods used in the development of fraud screening plugins that allow CloudBlue Commerce to integrate with third-party fraud screening systems. For more information, refer to Overview and How to Develop Fraud Screening Plugins.

Method naming convention

%PluginName%_GetConfig

Purpose

This method is used for CloudBlue Commerce to receive and display the plug-in configuration parameters on the plug-in configuration screen in the provider control panel.

Mandatory / optional

This is one of the generic methods mandatory for all plugins.

Input Parameters

None.

Return Parameters

• config: an object of the \FraudSDK\Config type that describes the set of plug-in configuration parameters.

Relationship with other methods

None.

Implementation examples

Example 1. V&E plugin

function VNEDemo_GetConfig()
{
    $config = \FraudSDK\createConfig('Fraud SDK Validation and Eligibility Demo Plugin');

    $config->addConfigurationParameter('gateway_password')
           ->setTypePassword()
           ->setDefaultValue('somepassword');

    $config->addConfigurationParameter('gateway_username')
           ->setTypeString()
           ->setDefaultValue('someuser');

    return $config;
}

Example 2. Blacklist plugin

function BlacklistDemo_GetConfig()
{
    return \FraudSDK\createConfig('Fraud SDK ZIP Code Blacklist Demo Plugin');
}