Our recommended action. Use this to determine how you should handle the order. See source for the reason for this recommendation. One of:
ALLOW , REVIEW , or PREVENT . |
The reason for our recommended action. Do not implement any logic based upon this field as we may add new values in the future without warning. Options: CHARGEBACK - The action was based the customer having at least one unforgiven dispute.LOOKUP - The action was based on finding the customer in our Lookup fraud database.MANUAL_REVIEW - The action was based on a manual review.NETWORK - The action was based on how the customer was connected in our Connect graph network.RATE_LIMIT - This request was rate-limited. The action was based on the default action for rate-limited requests.RAVELIN - The action was based on the payment fraud score and your thresholds. See score.RULE - The action was based on a rule.
|
The fraud score produced by the machine learning model. A value between 0 and 100.
The higher the number the more fraudulently the model scored the customer. This may not be the source of the final recommendation, see source. |
The ID of the customer to which this recommendation applies. |
A unique ID for this score. |
If transaction optimisation is enabled, and a transaction optimisation recommendation was requested,
this will contain the recommendation and related details. Show definition
|
The identifier for the transaction, as provided in the request. | Our transaction optimisation recommendation for whether the transaction should be authenticated or sent straight to authorisation. One of:
AUTHENTICATE , or AUTHORISE . | The SCA exemption type to request for the transaction. One of:
TRANSACTION_RISK_ANALYSIS , or LOW_VALUE . | 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 . | The source of the given recommendation. One of:
ML , CLIENT_RULE , COMPLIANCE , or NO_ACTION_SOURCE . | Indicates the effect that PSD2 compliance had on the recommendation. Show definition
| | Indicates if we were able to optimise this transaction. | Indicates why a transaction is non-optimisable. Will only be present if optimisable is false . | Show definition
| Indicates a recommendation which was unavailable for the transaction for compliance reasons. Show definition
| One of:
AUTHENTICATE , or AUTHORISE . | One of:
LOW_VALUE , or TRANSACTION_RISK_ANALYSIS . |
| Indicates why this recommendation was unavailable for the transaction. |
|
| 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 name of the rule which triggered to produce the action. | The ID of the rule which triggered to produce the action. | The version number of the rule which triggered to produce the action. | The action which the rule produced. One of:
NONE , AUTHENTICATE , or AUTHORISE . | The exemption which the rule produced. One of:
TRANSACTION_RISK_ANALYSIS , or LOW_VALUE . | The 3DS challenge preference which the rule produced. One of:
NO_PREFERENCE , NO_CHALLENGE_REQUESTED , CHALLENGE_REQUESTED , or CHALLENGE_REQUESTED_AS_MANDATE . | Whether the rule triggered. | The state of the rule when it executed.
An active rule is live, whereas a passive rule is in test mode. One of:
active , or passive . | Whether the recommendation from the rule is excluded for compliance reasons. |
|
|
|
Contains an enriched AReq that can be passed on to your 3DS provider.
Please see the 3DS Data Enrichment guide
for more details. Show definition
|
Contains AReq fields that can be passed on to your 3DS provider. Show definition
| Information about the cardholder's account. Show definition
| Length of time that the cardholder has had the account. One of the following: 01 - No account (guest check-out)02 - Changed during this transaction03 - Less than 30 days04 - 30−60 days05 - More than 60 days
| Date that the cardholder opened the account. | Number of purchases by this cardholder account during the last six months. | Date that the payment method was added to the cardholder’s account. | Indicates the length of time since the payment method was added to the cardholder’s account. One of the following: 01 - No account (guest check-out)02 - During this transaction03 - Less than 30 days04 - 30−60 days05 - More than 60 days
| Number of transactions (successful and abandoned) by this cardholder account across all payment methods in the last 24 hours. | Number of transactions (successful and abandoned) by this cardholder account across all payment methods in the last year. | Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. One of the following: 01 - No suspicious activity has been observed02 - Suspicious activity has been observed
|
| Indicates whether a challenge is requested for this transaction. One of the following: 01 - No preference02 - No challenge requested03 - Challenge requested (3DS Requestor preference)04 - Challenge requested (mandate, e.g. required for PSD2 compliance)05 - No challenge requested (transactional risk analysis is already performed)10 - No challenge requested (utilise low value exemption)
| Merchant name assigned by the acquirer. | Merchant category code. A card scheme specific code describing the merchant’s type of business, product or service. | Indicates whether the billing address and shipping address are the same. One of the following: Y - Billing address matches shipping addressN - Billing address does not match shipping address
| First line of the billing address associated with the card used for this purchase. | Second line of the billing address associated with the card used for this purchase. | The city of the billing address associated with the card used for this purchase. | ISO 3166-2 country subdivision code for the state or province of the billing address associated with the card used for this purchase. | ZIP or other postal code of the billing address associated with the card used for this purchase. | The numeric country code of the billing address associated with the card used for this purchase. | First line of the shipping address requested by the cardholder. | Second line of the shipping address requested by the cardholder. | City of the shipping address requested by the cardholder. | ISO 3166-2 country subdivision code for the state or province of the shipping address requested by the cardholder. | The ZIP or other postal code of the shipping address requested by the cardholder. | Numeric country of the shipping address requested by the cardholder. |
|
|
Warnings when the data you are sending may negatively impact fraud detection. Show definition
|
Identifier for this warning. Format is [a-z-]+ so you can safely record it in your metrics system. | A link to more information about this class of warning and the impact of not resolving. | A description indicating why this warning has been issued. |
|
In order to provide resiliency, on the rare occasion that Ravelin isn’t able to calculate a
fraud score, a cached score is used to determine the action.
If a cached score was used, this field will be true . |
Specifies the time the score was originally calculated. Uses the format 2020-01-01T00:00:00.00000000Z . |
rules
objectResponse Version 2 Contains details about the rules which were triggered by this customer. Show definition
|
The action which would have been returned if all test rules were live. | An array containing the details of the rules which were triggered. Show definition
| The name of the rule which triggered to produce the action. | Whether the rule triggered. | The state of the rule.
If the rule is live mode, the state will be active .
If the rule is in test mode, the state will be passive . One of:
active , or passive . | The ID of the rule which triggered to produce the action. | The version number of the rule which triggered to produce the action. | The collections the rule belongs to. | The category of the rule which triggered to produce the action, as set in the dashboard when the rule was created. Options: payment - Rules created to reduce payment fraud or implement payment-related business logic.ato - Rules created to prevent account takeover.txOptimisation - Rules created to optimise transaction routing and manage strong customer authentication exemptions.refundAbuse - Rules created to prevent refund abuse.psp - Rules created to optimise payment service providers performance.supplier - Rules created to prevent supplier fraud.
| A human-readable explanation of why the rule triggered. | The action which the rule produced. |
|
|
Contains details about the network the customer is connected to. Show definition
|
Indicates that the customer was within a certain distance to fraud in the network.
The customer will have received a REVIEW or PREVENT payment fraud recommendation depending on their distance to fraud.
See their customer profile in the Ravelin dashboard for more details about their distance to fraud. |
|
lookup
objectResponse Version 2 Contains details about the Lookup results for the customer. Show definition
|
The payment fraud recommendation which was produced from the Lookup result.
May not be the final recommendation. One of:
REVIEW , or PREVENT . | Contains details about the Lookup results for the customer. Show definition
| If you have configured Lookup to only search a specific industry, this is the industry which was searched. | Indicates whether the customer has disputes in any of the Lookup results. | Indicates whether the customer has been reviewed as a fraudster in any of the Lookup results. | Contains details about the Lookup result found using the customer's email address. Show definition
| The email address found in Lookup. | Indicates the customer has disputes. | Indicates the customer has been reviewed as a fraudster. |
| Contains details about the Lookup result found using the customer's telephone number. Show definition
| The telephone number found in Lookup. | Indicates the customer has disputes. | Indicates the customer has been reviewed as a fraudster. |
| Contains details about the Lookup result found using the customer's IP address. Show definition
| The IP address found in Lookup. | Indicates whether the customer has disputes. | Indicates whether the customer has been reviewed as a fraudster. |
|
|
|
market
objectResponse Version 2 Contains details about the market for the customer. Show definition
|
The city that the customer belongs to, based on their latest order. Used for reporting and risk bucketing. This is populated from the order.marketCity field from the customer's latest order. | The country the customer is from, based on their latest order. Used for reporting and risk bucketing. This is populated from the order.country field from the customer's latest order. | The country-group market the customer belongs to. E.g. 'southamerica', 'europe', 'emea'.
Used for reporting and risk bucketing. This is populated from the order.market field from the customer's latest order. |
|
Contains details about the machine learning fraud score thresholds. Show definition
|
The review fraud score threshold.
If the fraud score is used to produce the recommendation,
a score above this threshold, but below the prevent threshold will produce a REVIEW recommendation. | The prevent fraud score threshold. If the fraud score is used to produce the recommendation, a score above this threshold will produce a PREVENT recommendation. |
|
The ID of the order used to calculate the recommendation, typically the customer's latest order. |
The ID of the transaction used to calculate the recommendation, typically the customer's latest transaction. |