VTEX · Schema

SendAntifraudDataRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	VTEX transaction ID. The ID of the transaction related with this payment.
reference	string	VTEX order reference key. The key of the order (from VTEX Orders system) related with this payment.
value	integer	VTEX transaction order value.
ip	string	Original IP address from browser.
store	string	Store name. This is the same name used to access the store Admin via URL.
deviceFingerprint	string	Device fingerprint generated by the provider. This is generated by using Google Tag Manager that the provider implements. This field is optional, is sent only if received.
miniCart	object
payments	object
hook	string	URL to be called when the payment status changes. For more information, see [Authorization and Callback URL](https://developers.vtex.com/docs/guides/payments-integration-purchase-flows#authorization).
transactionStartDate	string	Date and time when the transaction started, in ISO 8601 format.
merchantSettings	array	Custom fields (for the given Provider) which the Merchant must fill. Each element of this array is a key-value pair.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SendAntifraudDataRequest",
  "title": "SendAntifraudDataRequest",
  "required": [
    "id",
    "reference",
    "value",
    "ip",
    "store",
    "deviceFingerprint",
    "miniCart",
    "payments",
    "sellerId",
    "hook",
    "transactionStartDate"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "VTEX transaction ID. The ID of the transaction related with this payment.",
      "example": "D3AA1FC8372E430E8236649DB5EBD08E"
    },
    "reference": {
      "type": "string",
      "description": "VTEX order reference key. The key of the order (from VTEX Orders system) related with this payment.",
      "example": "vtexargentina"
    },
    "value": {
      "type": "integer",
      "description": "VTEX transaction order value.",
      "example": 10
    },
    "ip": {
      "type": "string",
      "description": "Original IP address from browser.",
      "example": "10.0.0.1"
    },
    "store": {
      "type": "string",
      "description": "Store name. This is the same name used to access the store Admin via URL.",
      "example": "serasa"
    },
    "deviceFingerprint": {
      "type": "string",
      "description": "Device fingerprint generated by the provider. This is generated by using Google Tag Manager that the provider implements. This field is optional, is sent only if received.",
      "example": "Generated_using_GTM_Store_Is_Responsible_To_Configure"
    },
    "miniCart": {
      "$ref": "#/components/schemas/MiniCart"
    },
    "payments": {
      "$ref": "#/components/schemas/Payment"
    },
    "hook": {
      "type": "string",
      "description": "URL to be called when the payment status changes. For more information, see [Authorization and Callback URL](https://developers.vtex.com/docs/guides/payments-integration-purchase-flows#authorization).",
      "example": "https://hook.vtex.com/notifyIfChangeStatus"
    },
    "transactionStartDate": {
      "type": "string",
      "description": "Date and time when the transaction started, in ISO 8601 format.",
      "example": "2020-10-30T18:08:23Z"
    },
    "merchantSettings": {
      "type": "array",
      "description": "Custom fields (for the given Provider) which the Merchant must fill. Each element of this array is a key-value pair.",
      "items": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Custom field name.",
            "example": "Country"
          },
          "value": {
            "type": "string",
            "description": "Custom field name.",
            "example": "BRL"
          }
        }
      }
    }
  }
}