Skip to main content

Response

You'll receieve webhooks once you've submitted transactions

  • After submitting your request, the success response you will receive can be seen below:
{
 "message": "Transaction submitted"
}
  • Once your request has finished processing, a webhook will be sent to your pre-defined webhook URL.

Response Codes

CodeDescription
100Transaction looks safe
101Transaction poses a medium risk & needs review
102High risk transaction
104Transaction is from a blacklisted user
105Transaction is from a blacklisted device

Example Response

{
    "transactionId": "fL3fPIvnIAr4RzOGfbm0",
    "riskScore": "0.09",
    "action": {
        "result": "approved",
        "code": 1
    },
    "ruleResult": "looks safe",
    "reason": {
        "code": "100",
        "severity": "low",
        "rule": {
            "id": "652d78e04017034bc03cc91a",
            "name": "Fraud analyst"
        }
    }
}
{   
    "transactionId": "fL3fPIvnIAr4RzOGfbm0",
    "riskScore": "0.09",
    "action": {
        "result": "approved",
        "code": 1
    },
    "ruleResult": "looks safe",
    "reason": {
        "code": "100",
        "severity": "low",
        "rule": {
            "id": "652d78e04017034bc03cc91a",
            "name": "Fraud analyst"
        }
    }
}
{   
    "transactionId": "fL3fPIvnIAr4RzOGfbm0",
    "riskScore": "0.59",
    "ruleResult": "needs review",
    "reason": {
        "code": "101",
        "severity": "medium",
        "rule": {
            "id": "652d78e04017034bc03cc91a",
            "name": "Fraud analyst"
        }
    }
}
{   
     "transactionId": "fL3fPIvnIAr4RzOGfbm0",
    "riskScore": "0.89",
    "action": {
        "result": "rejected",
        "code": 0
    },
    "ruleResult": "fraudulent",
    "reason": {
        "code": "102",
        "severity": "high",
        "message" : "high risk",
        "rule": {
            "id": "652d78e04017034bc03cc91a",
            "name": "Fraud analyst"
        }
    }
}
{    
    "transactionId": "fL3fPIvnIAr4RzOGfbm0",
    "riskScore": "0.41",
    "ruleResult": "needs review",
        "reason": {
        "code": "104",
        "severity": "high",
        "message" : "transaction originated from a blacklisted user",
    }
}
{    
     "transactionId": "fL3fPIvnIAr4RzOGfbm0",
        "riskScore": "0.39",
        "ruleResult": "needs review",
        "reason": {
        "code": "105",
            "severity": "high",
            "message" : "transaction originated from a blacklisted device",
    }
}
ParameterTypeDescription
transaction_idStringThe ID of the transaction that was checked for fraud.
risk_scoreStringA score indicating the level of risk associated with the transaction.
actionObjectAn object that provides info about the final decision taken on the transaction. This object is only returned when the final decision is taken.
action.resultStringThis is the final result of the transaction check. It is either "approved" or "rejected".
action.codeNumberThis is the numerical code representation of the result. 1 = Approved. 0 = Rejected.
ruleResultStringThis is the result after the rules set have been executed.
reasonObjectAn object that provides more detailed information about why the transaction is considered fraudulent.
reasons.codeStringA unique code that identifies the reason for the transaction being considered fraudulent.
reasons.messageStringA human-readable description of the reason for the transaction being considered fraudulent.
reasons.severityStringIndicates the severity of the reason for the transaction being considered fraudulent (e.g., high, medium, or low).
reasons.ruleObjectIf the transaction was flagged, rejected or approved by a rule, the rule object will be present to notify you of the rule that took effect on the transaction.