GetRequiredData

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

Method naming convention

%PluginName%_GetRequiredData

Purpose

This method is used for CloudBlue Commerce to receive the list of data required for CheckCondition calls.

Mandatory / optional

This is one of the generic methods implemented optionally.

Input Parameters

None.

Return Parameters

• required_data – object of the \FraudSDK\RequiredData type that describes the dataset to be passed to the CheckCondition method.

Relationship with other methods

This method defines the input data for the CheckCondition method.

Implementation examples

Example 1. V&E plug-in

function VNEDemo_GetRequiredData()
{
    return
        \FraudSDK\createRequiredData()
        ->requireCustomer()
        ->requireCustomerAttributes();
}

Example 2. Blacklist plug-in

function BlacklistDemo_GetRequiredData()
{
    return
        \FraudSDK\createRequiredData()
        ->requireCustomer();
}