VTEX · Example Payload

Vtex Updateantifraudtransactionsoptional Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Updateantifraudtransactionsoptional Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "UpdateAntifraudTransactions(optional)",
  "method": "PUT",
  "path": "/transactions/{transactionId}",
  "summary": "VTex Update Anti-fraud Transactions (optional)",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "id": "D3AA1FC8372E430E8236649DB5EBD08E",
        "reference": "v32478982vtx-01",
        "value": 10,
        "ip": "10.0.0.1",
        "store": "serasa",
        "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure",
        "miniCart": {
          "buyer": {
            "id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
            "firstName": "John",
            "lastName": "Doe",
            "document": "012.345.678-90",
            "documentType": "CPF",
            "email": "john@doe.com",
            "phone": "+5521987654321",
            "address": {
              "country": "BRA",
              "street": "Rua Praia de Botafogo",
              "number": "518",
              "complement": "2o. andar",
              "neighborhood": "Botafogo",
              "postalCode": "22250-040",
              "city": "Rio de Janeiro",
              "state": "RJ"
            }
          },
          "shipping": {
            "value": 8.41,
            "estimatedDate": "2017-08-02T14:46:47",
            "address": {
              "country": "BRA",
              "street": "Rua Praia de Botafogo",
              "number": "518",
              "complement": "2o. andar",
              "neighborhood": "Botafogo",
              "postalCode": "22250-040",
              "city": "Rio de Janeiro",
              "state": "RJ"
            }
          },
          "items": [
            {
              "id": "132981",
              "name": "Some useful product",
              "price": 20.51,
              "quantity": 2,
              "deliveryType": "Normal",
              "deliverySlaInMinutes": 4320,
              "categoryId": "111",
              "categoryName": "Electronica",
              "discount": 1.99,
              "sellerId": "vtexargentina"
            },
            {
              "id": "123242",
              "name": "Some useless product",
              "price": 21.98,
              "quantity": 1,
              "deliveryType": "Normal",
              "deliverySlaInMinutes": 4320,
              "categoryId": "123",
              "categoryName": "Lar",
              "discount": 1.01,
              "sellerId": "vtexargentina"
            }
          ],
          "taxValue": 5.58,
          "listRegistry": {
            "name": "Minha lista Presente",
            "deliveryToOwner": false
          }
        },
        "payments": [
          {
            "id": "2D00FE",
            "method": "CreditCard",
            "name": "Visa",
            "value": 63.98,
            "currencyIso4217": "BRL",
            "installments": 3,
            "details": {
              "bin": "507860",
              "lastDigits": "2798",
              "holder": "John Doe",
              "address": {
                "country": "BRA",
                "street": "Rua Praia de Botafogo",
                "number": "518",
                "complement": "2o. andar",
                "neighborhood": "Botafogo",
                "postalCode": "22250-040",
                "city": "Rio de Janeiro",
                "state": "RJ"
              }
            }
          },
          {
            "id": "04D430E517B2494FBC3DF7721CCDACC7",
            "method": "GiftCard",
            "value": 10.01,
            "currencyIso4217": "BRL",
            "installments": 1
          }
        ],
        "hook": "https://hook.vtex.com/notifyIfChangeStatus"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "D3AA1FC8372E430E8236649DB5EBD08E",
        "status": "approved",
        "fraudRiskPercentage": 0,
        "analysisType": "automatic",
        "responses": null
      }
    }
  ]
}