PSPs > API Reference > Endpoints > Score

Score

Jump to Response

GET api.ravelin.com/psp/transaction/{transactionId}/score/{scoreId}

Response

data object

Holds information about Ravelin's recommendation for this transaction if requested.

Show definition

action string optional

Ravelin's recommended action for this transaction.

rules object

Information about rules that have fired

Show definition

passiveAction string optional

What Ravelin's recommended action for this transaction would have been if all test rules were active.

triggered object

Show definition

action string optional

The action which the rule produced

description string optional

A description of the rule conditions

ruleId integer optional

The ID of the rule that fired

ruleVersion integer optional

The version of the rule that fired

state string optional

Whether the rule is an active rule or a test (passive) rule

score integer optional

The Ravelin machine learning model score for the transaction, if available. The score will be integral number between 0 and 100. Larger values are a stronger indication of fraud. Note that this score is not the only factor in Ravelin's recommendation and in some cases may be ignored.

scoreId string optional

Ravelin's ID for this recommendation.

transactionId string optional

The ID of the transaction that this recommendation is for.

transactionOptimisation object

If transaction optimisation is enabled, and a transaction optimisation recommendation was requested, this will contain the recommendation and related details.

Show definition

action string optional

Our transaction optimisation recommendation for whether the transaction should be authenticated or sent straight to authorisation.

actionSource string optional

The source of the given recommendation.

exemption string optional

The SCA exemption type to request for the transaction.

ruleId integer optional

The ID of the rule which triggered to produce the action.

ruleVersion integer optional

The version number of the rule which triggered to produce the action.

rules object

Indicates which rules were triggered to cause the given recommendation.

Show definition

passiveAction string optional

What Ravelin's recommended action for this transaction would have been if all test rules were active.

triggered object

Show definition

action string optional

The action which the rule produced.

description string optional

A description of the rule conditions.

exemption string optional

The exemption which the rule produced.

ruleId integer optional

The ID of the rule that fired.

ruleVersion integer optional

The version of the rule that fired.

state string optional

Whether the rule is an active rule or a test (passive) rule.

threeDSChallengePreference string optional

The 3DS challenge preference which the rule produced.

threeDSChallengePreference string optional

The preference for whether or not a 3DS challenge should be performed. This field is only present if action is AUTHENTICATE.

message string optional

If an error has occurred, a description of the error.

status integer optional

HTTP response status code.

timestamp integer optional

UNIX timestamp when Ravelin finished handling the request

HTTP/1.1 200 OK
Content-Type: applicaton/json

{
  "data": {
    "action": "ALLOW",
    "rules": {
      "passiveAction": "PREVENT",
      "triggered": [
        {
          "action": "REVIEW",
          "description": "Psp.secondsSinceEmailFirstSeen is less than 200.",
          "ruleId": 14384,
          "ruleVersion": 7,
          "state": "active"
        }
      ]
    },
    "score": 76,
    "scoreId": "b4a88559-5090-44fb-8a31-eff8a00a79dd",
    "transactionId": "6cbe7636-3c15-45e8-bf29-2f010ae829bf"
  },
  "status": 200,
  "timestamp": 1512828988826
}

Feedback

Was this page helpful?