Record Class ScoreResponse

java.lang.Object
java.lang.Record
com.maxmind.minfraud.response.ScoreResponse
Record Components:
disposition - The disposition set by your custom rules.
fundsRemaining - The approximate US dollar value of the funds remaining on your MaxMind account.
id - This is a UUID that identifies the minFraud request.
ipAddress - The IpAddress model object.
queriesRemaining - The approximate number of queries remaining for this service before your account runs out of funds.
riskScore - This returns 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.
warnings - An unmodifiable list containing warning objects that detail issues with the request such as invalid or unknown inputs. It is highly recommended that you check this list for issues when integrating the web service.
All Implemented Interfaces:
JsonSerializable
public record ScoreResponse(Disposition disposition, Double fundsRemaining, UUID id, ScoreIpAddress ipAddress, Integer queriesRemaining, Double riskScore, List<Warning> warnings) extends Record implements JsonSerializable
This class represents the minFraud Score response.

  • Constructor Details

    • ScoreResponse

      public ScoreResponse(Disposition disposition, Double fundsRemaining, UUID id, ScoreIpAddress ipAddress, Integer queriesRemaining, Double riskScore, List<Warning> warnings)
      Compact canonical constructor that sets defaults for null values.

    • ScoreResponse

      public ScoreResponse()
      Constructs an instance of ScoreResponse with no data.

  • Method Details

    • getDisposition

      @Deprecated(since="4.0.0", forRemoval=true) public Disposition getDisposition()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use disposition() instead. This method will be removed in 5.0.0.
      Returns:
      The disposition set by your custom rules.

    • getFundsRemaining

      @Deprecated(since="4.0.0", forRemoval=true) public Double getFundsRemaining()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use fundsRemaining() instead. This method will be removed in 5.0.0.
      Returns:
      The approximate US dollar value of the funds remaining on your MaxMind account.

    • getId

      @Deprecated(since="4.0.0", forRemoval=true) public UUID getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use id() instead. This method will be removed in 5.0.0.
      Returns:
      This is a UUID that identifies the minFraud request.

    • getIpAddress

      @Deprecated(since="4.0.0", forRemoval=true) public IpAddressInterface getIpAddress()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ipAddress() instead. This method will be removed in 5.0.0.
      Returns:
      The IpAddress model object.

    • getQueriesRemaining

      @Deprecated(since="4.0.0", forRemoval=true) public Integer getQueriesRemaining()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use queriesRemaining() instead. This method will be removed in 5.0.0.
      Returns:
      The approximate number of queries remaining for this service before your account runs out of funds.

    • getRiskScore

      @Deprecated(since="4.0.0", forRemoval=true) public Double getRiskScore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use riskScore() instead. This method will be removed in 5.0.0.
      Returns:
      This returns 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.

    • getWarnings

      @Deprecated(since="4.0.0", forRemoval=true) public List<Warning> getWarnings()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use warnings() instead. This method will be removed in 5.0.0.
      Returns:
      An unmodifiable list containing warning objects that detail issues with the request such as invalid or unknown inputs. It is highly recommended that you check this list for issues when integrating the web service.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • disposition

      public Disposition disposition()
      Returns the value of the disposition record component.
      Returns:
      the value of the disposition record component

    • fundsRemaining

      public Double fundsRemaining()
      Returns the value of the fundsRemaining record component.
      Returns:
      the value of the fundsRemaining record component

    • id

      public UUID id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • ipAddress

      public ScoreIpAddress ipAddress()
      Returns the value of the ipAddress record component.
      Returns:
      the value of the ipAddress record component

    • queriesRemaining

      public Integer queriesRemaining()
      Returns the value of the queriesRemaining record component.
      Returns:
      the value of the queriesRemaining record component

    • riskScore

      public Double riskScore()
      Returns the value of the riskScore record component.
      Returns:
      the value of the riskScore record component

    • warnings

      public List<Warning> warnings()
      Returns the value of the warnings record component.
      Returns:
      the value of the warnings record component