Class: Minfraud::Model::Score

Inherits:
Abstract
  • Object
show all
Defined in:
lib/minfraud/model/score.rb

Overview

Model of the Score response.

Direct Known Subclasses

Insights

Instance Attribute Summary collapse

Instance Attribute Details

#disposition ⇒ Minfraud::Model::Disposition (readonly)

An object containing the disposition set by custom rules.

Returns:



15
16
17
 
# File 'lib/minfraud/model/score.rb', line 15

def disposition
  @disposition
end

#funds_remaining ⇒ Float (readonly)

The approximate US dollar value of the funds remaining on your MaxMind account.

Returns:

  • (Float) 


21
22
23
 
# File 'lib/minfraud/model/score.rb', line 21

def funds_remaining
  @funds_remaining
end

#id ⇒ String (readonly)

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/minfraud/model/score.rb', line 28

def id
  @id
end

#ip_address ⇒ Minfraud::Model::ScoreIPAddress (readonly)

An object containing the IP risk for the transaction.

Returns:



33
34
35
 
# File 'lib/minfraud/model/score.rb', line 33

def ip_address
  @ip_address
end

#queries_remaining ⇒ Integer (readonly)

The approximate number of queries remaining for this service before your account runs out of funds.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/minfraud/model/score.rb', line 39

def queries_remaining
  @queries_remaining
end

#risk_score ⇒ Float (readonly)

This property contains the risk score, from 0.01 to 99. A higher score indicates a higher risk of fraud. For example, a score of 20 indicates a 20% chance that a transaction is fraudulent. We never return a risk score of 0, since all transactions have the possibility of being fraudulent. Likewise we never return a risk score of 100.

Returns:

  • (Float) 


48
49
50
 
# File 'lib/minfraud/model/score.rb', line 48

def risk_score
  @risk_score
end

#warnings ⇒ Array<Minfraud::Model::Warning> (readonly)

This array contains objects detailing issues with the request that was sent, such as invalid or unknown inputs. It is highly recommended that you check this array for issues when integrating the web service.

Returns:



55
56
57
 
# File 'lib/minfraud/model/score.rb', line 55

def warnings
  @warnings
end