VTEX · Schema

ApproveAntifraudAnalysisResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string VTEX transaction ID. The ID of this transaction must be in the response.
status string Transaction status from provider. Must be one of the values: `approved`, `denied` or `undefined`.
fraudRiskPercentage number Fraud risk percentage.
analysisType string Analysis type. Valid values are `automatic` or `manual`.
responses string Value dictionary to add custom responses from analysis.
View JSON Schema on GitHub

JSON Schema

vtex-approveantifraudanalysisresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApproveAntifraudAnalysisResponse",
  "title": "ApproveAntifraudAnalysisResponse",
  "required": [
    "id",
    "status",
    "fraudRiskPercentage",
    "analysisType",
    "responses"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "VTEX transaction ID. The ID of this transaction must be in the response."
    },
    "status": {
      "type": "string",
      "description": "Transaction status from provider. Must be one of the values: `approved`, `denied` or `undefined`."
    },
    "fraudRiskPercentage": {
      "type": "number",
      "description": "Fraud risk percentage."
    },
    "analysisType": {
      "type": "string",
      "description": "Analysis type. Valid values are `automatic` or `manual`."
    },
    "responses": {
      "type": "string",
      "nullable": true,
      "description": "Value dictionary to add custom responses from analysis."
    }
  }
}