VTEX Payments Gateway MCP connector

VTEX Payments Gateway is VTEX's payment processing platform for managing transactions, provider configurations, and payment rules across e-commerce operations. The VTEX Payments Gateway MCP connector allows AI agents to configure payment affiliations and providers, define installment options and payment methods, and send transaction information to external systems. It also supports managing payment rules, retrieving affiliation details, and monitoring available payment methods across storefronts.

Authentication type

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

Uses

Use the VTEX Payments Gateway MCP connector to perform the following actions:

• Process payment transactions securely through multiple provider integrations
• Configure payment affiliations and provider rules for transaction routing
• Authorize, settle, and refund transactions across payment methods
• Retrieve installment options and available payment methods for customers
• Store and reuse customer credit cards for recurring payments
• Track transaction details and settlement status in real time
• Cancel pending transactions before authorization or settlement

Example prompts

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

• Show me all active payment affiliations in VTEX Payments Gateway.
• Create a new payment rule for credit card transactions in VTEX Payments Gateway.
• What payment methods are available for customers in VTEX Payments Gateway?
• Start a new payment transaction in VTEX Payments Gateway for order 12345.
• Authorize the pending transaction and retrieve its confirmation details from VTEX Payments Gateway.
• Refund the completed transaction 67890 in VTEX Payments Gateway.
• Settle all transactions from today in VTEX Payments Gateway.
• Get installment options for a purchase of $5,000 in VTEX Payments Gateway.
• Cancel the transaction that failed authorization in VTEX Payments Gateway.
• List all payment rules currently active in VTEX Payments Gateway.

VTEX Payments Gateway MCP connector tools

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

Tool	Description
2_SendPaymentsPublic	Submits payment information for processing without requiring saved payment credentials.
Affiliations	Retrieves a list of all payment affiliations configured in the system.
InsertAffiliation	Creates a new payment affiliation with the specified details.
AffiliationById	Retrieves details for a specific payment affiliation by its identifier.
UpdateAffiliation	Modifies settings for an existing payment affiliation.
Installmentsoptions	Retrieves available installment plans for payment transactions.
AvailablePaymentMethods	Retrieves a list of payment methods available for transactions.
Rules	Retrieves all payment rules configured in the system.
InsertRule	Creates a new payment rule with specified conditions and settings.
Rule	Removes a payment rule from the system.
RuleById	Retrieves details for a specific payment rule by its identifier.
PutRuleById	Updates settings for an existing payment rule.
1_Createanewtransaction	Initiates a new payment transaction in the system.
TransactionDetails	Retrieves complete information for a specific transaction.
3_SendAdditionalData	Submits supplementary transaction data for payment processing.
4_Doauthorization	Authorizes a transaction to proceed with fund capture.
Cancelthetransaction	Cancels an ongoing or pending payment transaction.
2_SendPaymentsWithSavedCreditCard	Submits payment using previously stored credit card information.
PaymentDetails	Retrieves comprehensive details for a specific payment record.
Refundthetransaction	Initiates a refund for a completed transaction.
Settlethetransaction	Finalizes settlement of a transaction for fund transfer.
TransactionSettlementDetails	Retrieves settlement status and details for a transaction.