GetBlacklistSchema

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%_GetBlacklistSchema

Purpose

This method returns the blacklist schema to CloudBlue Commerce.

Mandatory / optional

This is one of the fraud screening methods mandatory for all blacklist plugins. However, it is not necessary for non-blacklist or validation and eligibility plugins.

Input Parameters

None.

Return Parameters

• schema: an object of the \FraudSDK\BlacklistSchema type that defines the blacklist table columns.

Relationship with other methods

This method defines the blacklist parameter format for the CheckCondition method.

Implementation example. Blacklist plugin

function BlacklistDemo_GetBlacklistSchema()
{
    $blacklist = \FraudSDK\createBlacklist();

    $blacklist->addColumn('zip_code')
              ->setTypeString()
              ->setFriendlyName('ZIP Code')
              ->setDescription('Blacklisted ZIP code');

    return $blacklist;
}