VTEX · Example Payload

Vtex Refundthetransaction Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Refundthetransaction 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": "Refundthetransaction",
  "method": "POST",
  "path": "/api/pvt/transactions/{transactionId}/refunding-request",
  "summary": "VTex Refund the transaction",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "value": 2300,
        "freight": 200,
        "tax": 0,
        "minicart": {
          "items": [
            {
              "id": "122323",
              "name": "Tenis Preto I",
              "value": 1000,
              "quantity": 1,
              "shippingDiscount": 0,
              "discount": 50
            },
            {
              "id": "122324",
              "name": "Tenis Nike Azul",
              "value": 1100,
              "quantity": 1,
              "shippingDiscount": 0,
              "discount": 50
            }
          ]
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": null,
        "token": "2BCA48B4FBCB42D0B8A19EE965712AD8",
        "status": 11,
        "statusDetail": "Settling",
        "processingDate": "2023-12-14T22:45:50.9977213Z",
        "refundedValue": 2500,
        "refundedToken": null,
        "message": null,
        "code": null,
        "connectorRefundedValue": 0,
        "cancelledValue": 0
      }
    }
  ]
}