VTEX · Example Payload

Vtex Processorder Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Processorder 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

{
  "operationId": "ProcessOrder",
  "method": "POST",
  "path": "/api/checkout/pub/gatewayCallback/{orderGroup}",
  "summary": "VTex Process order",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "428",
      "contentType": "application/json",
      "example": {
        "RedirectResponseCollection": [
          {
            "redirectUrl": "https://bacen.pix/pix/\u2026"
          }
        ],
        "paymentAuthorizationAppCollection": [
          {
            "appName": "vtex.pix-payment",
            "appPayload": {
              "code": "https://bacen.pix/pix/\u2026",
              "expiresAt": "2023-07-12 14:18:11Z",
              "paymentId": "7AA33BDE370746839F2F8C5F13FE1D84",
              "transactionId": "7CEA6AD624D54F07825D37EDEAA746ED"
            }
          }
        ]
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "operationId": "a231ed11-255b-4ea0-96c3-1790e1b27f7e",
        "error": {
          "code": "001",
          "message": "Seu pagamento n\u00e3o foi autorizado. Falha ao enviar os dados de pagamento. Favor entrar em contato com o SAC ou utilizar outra forma de pagamento. *** ",
          "exception": null
        }
      }
    }
  ]
}