Documentation - Whasols

Module Parameters

The module parameters are the data/values passed into each function when called. Every fraud module function receives the same parameters. These parameters provide information about the specific order, client, credit card & module parameters the module command runs for. The parameters also contains the settings itself.

Parameters

Variable	Type	Notes
configurations	Array	Contains an array of all the configurable options defined on the module form. Again the key being the option name in this case
creditcard	Array	creditcard Parameter have all the information related to client credit card in admin area.
order	Array	Order Parameter have all the information related to order in admin area against order.
clientsdetails	Array	Client Parameter have all the information related to define client in admin area against client
Order Parameter Data mention below
id	int	Order Unique ID
order_number	bigint	The order unique number
amount	float	Order Amount
payment_method_id	int	Payment menthod Unique ID
payment_method	string	Payment method module name
payment_method_title	string	Payment method title
promo_code	string	Promotion code which applied during checkout
entry_date	string	Order Creation date
notes	string	Order notes which entered by client
ip_address	string	Client IP address
status	string	Order status
invoice_id	int	Invoice unique ID which created after order placing by client
currency	int	Client Currency unique ID
currencycode	string	Client Currency Code
Client Parameter Data mention below
id	int	Client Unique ID
firstname	string	Client First Name
lastname	stringstring	Client Last Name
username	string	Client Unique Username
email	string	Client Unique email address
phonenumber	string	Client Mobile Number
country	string	Client Country
city	string	Client city
state	string	Client state
fullname	string	Client Complete name
companyname	string	Client Company name
address1	string	Client Address 1
address2	string	Client Address 2
phonecc	string	Client Phone Country Code
postcode	string	Client Postal Code
payment_method	int	Client Selected Payment Method ID
language	string	Client Language
userid	int	Client unique ID
Additional Parameter Data mention below
ip	string	User IP address
sessionId	string	Session Unique ID
userAgent	string	User/Client UserAgent information
forwardedip	string	User Forwarded IP Address
acceptLanguage	string	User acceptLanguage
data	array	Module results values as Array
creditcard	array	Client Credit card data as Array

Data

data are fraud module results. These are returned by fraud module API response. Data: $params[‘data’]. data parameter have array set of key and values.

Note: Every module function except the _MetaData & getConfigArray function receives the $params array.

Click here to read about fraud module Fraud Check