VTEX · Example Payload

Vtex Getgiftcardtransactionbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getgiftcardtransactionbyid 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": "GetGiftCardTransactionbyID",
  "method": "GET",
  "path": "/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId}",
  "summary": "VTex Get GiftCard Transaction by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "value": 140,
        "description": "GiftCardHub",
        "date": "2023-06-02T18:24:49.252855Z",
        "requestId": "3",
        "settlement": {
          "href": "cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/settlements"
        },
        "cancellation": {
          "href": "cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/cancellations"
        },
        "authorization": {
          "href": "cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/authorization"
        },
        "operation": "Credit"
      }
    }
  ]
}