NAME

WebService::MinFraud::Model::Score - Model class for minFraud: Score

VERSION

version 1.010000

SYNOPSIS

use 5.010;

use WebService::MinFraud::Client;

my $client = WebService::MinFraud::Client->new(
    account_id  => 42,
    license_key => 'abcdef123456',
);

my $request = { device => { ip_address => '24.24.24.24' } };
my $score = $client->score($request);
say $score->risk_score;

DESCRIPTION

This class provides a model for the data returned by the minFraud Score web service.

For more details, see the API documentation.

METHODS

This class provides the following methods:

disposition

Returns a WebService::MinFraud::Record::Disposition object representing the disposition set for the transaction using custom rules.

funds_remaining

Returns the approximate US dollar value of the funds remaining on your account. The fund calculation is near realtime so it may not be exact.

id

Returns a UUID that identifies the minFraud request. Please use this UUID in bug reports or support requests to MaxMind so that we can easily identify a particular request.

ip_address

Returns a WebService::MinFraud::Record::ScoreIPAddress object representing IP address data for the transaction.

queries_remaining

Returns the approximate number of queries remaining for this service before your account runs out of funds. The query counts are near realtime so they may not be exact.

risk_score

Returns the risk score which is a number between 0.01 and 99. A higher score indicates a higher risk of fraud.

warnings

Returns an ArrayRef of WebService::MinFraud::Record::Warning objects. It is highly recommended that you check this array for issues when integrating the web service.

PREDICATE METHODS

The following predicate methods are available, which return true if the related data was present in the response body, false if otherwise:

has_funds_remaining

has_id

has_queries_remaining

has_risk_score

has_warnings

SUPPORT

Bugs may be submitted through https://github.com/maxmind/minfraud-api-perl/issues.

AUTHOR

Mateu Hunter <mhunter@maxmind.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 - 2020 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.