VTEX · Example Payload

Vtex Settlepayment Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Settlepayment 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": "SettlePayment",
  "method": "POST",
  "path": "/payments/{paymentId}/settlements",
  "summary": "VTex Settle payment",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "settleId": "2EA354989E7E4BBC9F9D7B66674C2574",
        "value": 57,
        "code": null,
        "message": "Successfully settled",
        "requestId": "DCEAA1FC8372E430E8236649DB5EBD08E",
        "connectorMetadata": [
          {
            "name": "MetadataName",
            "value": "MetadataValue"
          }
        ]
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "settleId": null,
        "value": 0,
        "code": "ERR123",
        "message": "Settlement has failed due to an internal error",
        "requestId": "DCEAA1FC8372E430E8236649DB5EBD08E"
      }
    }
  ]
}