Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-02112393.9 KB
Transactions

Cancel a gift card transaction

This request can be used to:

  1. Cancel a transaction for a specific gift card.

  2. Cancel an item's reservation or create a refund.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
GiftCardGiftCardGift card full access

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/giftcards/{giftCardId}/transactions/{transactionId}/cancellations

Path parameters

giftCardIdstring required
Example:6

Gift card identification.

transactionIdstring required
Example:b476900c

Transaction identification.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

valuenumber required

Value information.

requestIdstring required

VTEX request identifier.

Example request

{
  "value": 17.4,
  "requestId": "6360f98eb0cf6fd5afa77e39bba8c20fe5807d8c"
}

Response

OK

oidstring required

Operation identification.

valuenumber required

Value information.

datestring required

Date of the transaction in ISO 8601 format (YYYY-MM-DDThh:mm:ss.fff).