VTEX GiftCard MCP connector

VTEX Gift Card is VTEX's payment solution for managing gift cards as a payment method within e-commerce stores. The VTEX GiftCard MCP connector allows AI agents to create and retrieve gift cards, process transactions including authorizations and settlements, and manage transaction lifecycles with cancellations. It also supports querying transaction histories, retrieving specific transaction details by ID, and monitoring all authorization and settlement activities across gift card operations.

Authentication type

• API Key - Requires a static API key to be configured before the agent can connect to the service.

Uses

Use the VTEX GiftCard MCP connector to perform the following actions:

• Create and activate gift cards for customer purchases and promotional campaigns
• Track gift card balances and transaction history across your VTEX storefront
• Process gift card payments and authorize transactions in real time
• Cancel or reverse failed gift card transactions to correct errors
• Settle gift card transactions and reconcile payment records
• Query gift card authorizations, cancellations, and settlements for reporting
• Manage gift card lifecycle from creation through final settlement

Example prompts

Use the following example prompts to invoke VTEX GiftCard MCP connector tools from your AI assistant or Boomi Connect workflow:

• Create a new gift card in VTEX GiftCard with a $100 balance.
• Show me the transaction history for gift card ID GC-12345 in VTEX GiftCard.
• What is the current balance on gift card GC-98765 in VTEX GiftCard?
• Authorize a $50 payment against gift card GC-54321 in VTEX GiftCard.
• Cancel the failed transaction for gift card GC-11111 in VTEX GiftCard.
• Get all pending authorizations for gift cards in VTEX GiftCard from today.
• Settle the transaction for gift card GC-99999 in VTEX GiftCard.
• Find all canceled gift card transactions in VTEX GiftCard from last week.
• Show me which gift card transactions have been settled in VTEX GiftCard.
• Create a transaction record for a $25 gift card purchase in VTEX GiftCard.

VTEX GiftCard MCP connector tools

The VTEX GiftCard MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.

Tool	Description
CreateGiftCard	Creates a new gift card with specified value and configuration details.
GetGiftCardusingJSON	Retrieves gift card information by submitting structured data in JSON format.
GetGiftCardbyID	Retrieves details for a specific gift card using its unique identifier.
GetGiftCardTransactions	Retrieves a list of all transactions associated with a gift card.
CreateGiftCardTransaction	Creates a new transaction record for a gift card purchase or redemption.
GetGiftCardTransactionbyID	Retrieves details for a specific gift card transaction using its identifier.
GetTransactionAuthorizations	Retrieves authorization records for gift card transactions.
GetTransactionCancellations	Retrieves cancellation records for gift card transactions.
CancelGiftCardTransaction	Cancels an existing gift card transaction and reverses its effects.
GetTransactionSettlements	Retrieves settlement records for completed gift card transactions.
SettleGiftCardTransaction	Finalizes a gift card transaction and marks it as settled.