VTEX · Schema

GetAntifraudStatus

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	VTEX transaction ID. The ID of this transaction must be in the response.
tid	string	Provider transaction ID. The ID of this transaction must be in the response. The anti-fraud provider must generate a unique transaction ID.
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	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetAntifraudStatus",
  "title": "GetAntifraudStatus",
  "required": [
    "id",
    "tid",
    "status",
    "fraudRiskPercentage",
    "analysisType",
    "responses"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "VTEX transaction ID. The ID of this transaction must be in the response."
    },
    "tid": {
      "type": "string",
      "description": "Provider transaction ID. The ID of this transaction must be in the response. The anti-fraud provider must generate a unique transaction ID."
    },
    "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": {
      "$ref": "#/components/schemas/Responses"
    }
  }
}