VTEX · Example Payload

Vtex 1Createanewtransaction Example

CommerceE-CommerceRetailMarketplacePayments

Vtex 1Createanewtransaction 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": "1.Createanewtransaction",
  "method": "POST",
  "path": "/api/pvt/transactions",
  "summary": "VTex 1. Start a new transaction",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "46351F157C624CBA926359ADED377265",
        "transactionId": "46351F157C624CBA926359ADED377265",
        "referenceKey": "1234567",
        "interactions": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/interactions"
        },
        "settlements": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/settlements"
        },
        "payments": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/payments"
        },
        "refunds": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/refunds"
        },
        "cancellations": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/cancellations"
        },
        "capabilities": {
          "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/capabilities"
        },
        "timeoutStatus": 0,
        "totalRefunds": 0,
        "status": "Started",
        "value": 20000,
        "receiverUri": "https://cosmetics2.vtexpayments.com.br/split/46351F157C624CBA926359ADED377265/payments",
        "startDate": "2023-12-15T19:53:59.4307279Z",
        "authorizationToken": null,
        "authorizationDate": null,
        "commitmentToken": null,
        "commitmentDate": null,
        "refundingToken": null,
        "refundingDate": null,
        "cancelationToken": null,
        "cancelationDate": null,
        "fields": [
          {
            "name": "owner",
            "value": "teste_1@test.com"
          },
          {
            "name": "lastTransitionDate",
            "value": "12/15/2023 7:53:59 PM"
          },
          {
            "name": "TotalTimeSpentInTransitionsUntilThisTransition",
            "value": "0"
          },
          {
            "name": "channel",
            "value": "cosmetics2"
          },
          {
            "name": "salesChannel",
            "value": "1"
          }
        ],
        "ipAddress": null,
        "sessionId": null,
        "macId": null,
        "vtexFingerprint": null,
        "chargeback": null,
        "whiteSignature": null,
        "owner": "teste_1@test.com",
        "orderId": null,
        "userAgent": null,
        "acceptHeader": null,
        "antifraudTid": null,
        "antifraudResponse": null,
        "antifraudReference": null,
        "antifraudAffiliationId": null,
        "channel": "cosmetics2",
        "salesChannel": "1",
        "urn": null,
        "softDescriptor": null,
        "markedForRecurrence": false,
        "buyer": null
      }
    }
  ]
}