VTEX · Example Payload

Vtex Transactionsettlementdetails Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Transactionsettlementdetails 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": "TransactionSettlementDetails",
  "method": "GET",
  "path": "/api/pvt/transactions/{transactionId}/settlements",
  "summary": "VTex Get transaction settlement details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "requests": [
          {
            "id": "AFB933448FFD4867BF82BCC7026A082C",
            "date": "2018-06-05T13:08:22",
            "value": 4499000
          }
        ],
        "actions": [
          {
            "paymentId": "87055E7199A446519EB07F1243D5B8BE",
            "payment": {
              "href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE"
            },
            "date": "2018-06-05T12:55:58.6262759Z",
            "type": "auto-settlement",
            "value": 4499000,
            "connectorResponse": null
          }
        ]
      }
    }
  ]
}