Class: Minfraud::Model::Warning

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

Overview

Warning about the minFraud request.

Although more codes may be added in the future, the current warning codes are:

  • BILLING_CITY_NOT_FOUND - the billing city could not be found in our database.

  • BILLING_COUNTRY_MISSING - billing address information was provided without providing a billing country.

  • BILLING_COUNTRY_NOT_FOUND - the billing country could not be found in our database.

  • BILLING_POSTAL_NOT_FOUND - the billing postal could not be found in our database.

  • INPUT_INVALID - the value associated with the key does not meet the required constraints, e.g., “United States” in a field that requires a two-letter country code.

  • INPUT_UNKNOWN - an unknown key was encountered in the request body.

  • IP_ADDRESS_NOT_FOUND - the IP address could not be geolocated.

  • SHIPPING_COUNTRY_MISSING - shipping address information was provided without providing a shipping country.

  • SHIPPING_CITY_NOT_FOUND - the shipping city could not be found in our database.

  • SHIPPING_COUNTRY_NOT_FOUND - the shipping country could not be found in our database.

  • SHIPPING_POSTAL_NOT_FOUND - the shipping postal could not be found in our database.

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ String (readonly)

This value is a machine-readable code identifying the warning.

Returns:

  • (String) 


37
38
39
 
# File 'lib/minfraud/model/warning.rb', line 37

def code
  @code
end

#input_pointer ⇒ String? (readonly)

A JSON Pointer to the input field that the warning is associated with. For instance, if the warning was about the billing city, this would be ‘/billing/city’. If it was for the price in the second shopping cart item, it would be ‘/shopping_cart/1/price’.

Returns:

  • (String, nil) 


51
52
53
 
# File 'lib/minfraud/model/warning.rb', line 51

def input_pointer
  @input_pointer
end

#warning ⇒ String (readonly)

This property provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.

Returns:

  • (String) 


43
44
45
 
# File 'lib/minfraud/model/warning.rb', line 43

def warning
  @warning
end