VTEX · Example Payload

Vtex Settlegiftcardtransaction Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Settlegiftcardtransaction 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": "SettleGiftCardTransaction",
  "method": "POST",
  "path": "/giftcards/{giftCardId}/transactions/{transactionId}/settlements",
  "summary": "VTex Settle a gift card transaction",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "value": 17.4,
        "requestId": "6360f98eb0cf6fd5afa77e39bba8c20fe5807d8c"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "oid": "b8e0c606b2fe543e5b0e639575cd9723",
        "value": 17.4,
        "date": "2016-04-06T00:00:00"
      }
    }
  ]
}