Score Jump to Response
GET
api.ravelin.com/psp/transaction/{transactionId}/score/{scoreId}Response Holds information about Ravelin's recommendation for this transaction if requested.
Show definition
Ravelin's recommended action for this transaction.
Information about rules that have fired
Show definition
What Ravelin's recommended action for this transaction would have been if all test rules were active.
An array containing the details of the rules which were triggered.
Show definition
The action which the rule produced
The collections the rule belongs to.
A description of the rule conditions
The ID of the rule that triggered.
The name of the rule that triggered.
The version of the rule that triggered.
Whether the rule is an active rule or a test (passive) rule.
This must be either active or passive.
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.
Ravelin's ID for this recommendation.
The ID of the transaction that this recommendation is for.
If transaction optimisation is enabled, and a transaction optimisation recommendation was requested, this will contain the recommendation and related details.
Show definition
Our transaction optimisation recommendation for whether the transaction should be authenticated or sent straight to authorisation.
This must be either AUTHENTICATE or AUTHORISE.
The source of the given recommendation.
Indicates the effect that PSD2 compliance had on the recommendation.
Show definition
Indicates why a transaction is non-optimisable. Will only be present if optimisable is false.
Show definition
Indicates why this recommendation was unavailable for the transaction.
Indicates a recommendation which was unavailable for the transaction for compliance reasons.
Show definition
This must be either LOW_VALUE or TRANSACTION_RISK_ANALYSIS.
This must be either AUTHENTICATE or AUTHORISE.
Indicates if we were able to optimise this transaction.
The SCA exemption type to request for the transaction.
This must be either LOW_VALUE or TRANSACTION_RISK_ANALYSIS.
The ID of the rule which triggered to produce the action.
The version number of the rule which triggered to produce the action.
Indicates which rules were triggered to cause the given recommendation.
Show definition
An array containing the details of the rules which were triggered.
Show definition
The action which the rule produced.
This must be either AUTHORISE or AUTHENTICATE.
The collections the rule belongs to.
A description of the rule conditions.
Whether the recommendation from the rule is excluded for compliance reasons.
The exemption which the rule produced.
This must be either LOW_VALUE or TRANSACTION_RISK_ANALYSIS.
The ID of the rule that triggered.
The name of the rule that triggered.
The version of the rule that triggered.
Whether the rule is an active rule or a test (passive) rule.
This must be either active or passive.
The 3DS challenge preference which the rule produced.
One of: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED, or CHALLENGE_REQUESTED_AS_MANDATE.
The preference for whether or not a 3DS challenge should be performed. This field is only present if action is AUTHENTICATE.
One of: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED, or CHALLENGE_REQUESTED_AS_MANDATE.
If an error has occurred, a description of the error.
HTTP response status code.
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?
Yes
No Thanks for the feedback.
If you'd like to provide more detail, please email support@ravelin.com .