Skip to main content
Feedback

VTEX Payments Gateway MCP connector

Updated 

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:

  • Start and track payment transactions from initiation through settlement
  • Manage credit card affiliations for payment providers and acquirers
  • Configure payment rules to route transactions to specific providers
  • Retrieve available payment methods and installment options for checkout
  • Authorize, capture, cancel, and refund transactions in real time
  • Send additional transaction data to support fraud analysis and compliance
  • Review settlement details to reconcile payments across providers
  • Insert and update payment provider affiliations without manual configuration

Example prompts

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

  • Start a new payment transaction in VTEX Payments Gateway for this order.
  • Show me the available payment methods in VTEX Payments Gateway.
  • Cancel transaction 12345 in VTEX Payments Gateway.
  • Refund the payment for order 6789 in VTEX Payments Gateway.
  • List all payment rules configured in VTEX Payments Gateway.
  • Check the installment options for a $500 purchase in VTEX Payments Gateway.
  • Get the settlement details for last week's transactions in VTEX Payments Gateway.
  • Create a new affiliation for our credit card provider in VTEX Payments Gateway.
  • Authorize the pending transaction for customer order 456 in VTEX Payments Gateway.
  • Find the details for a specific transaction 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.

ToolDescription
2_SendPaymentsPublic2.1 Send Payments Information Public
AffiliationsAffiliations
InsertAffiliationInsert Affiliation
AffiliationByIdAffiliation By Id
UpdateAffiliationUpdate Affiliation
InstallmentsoptionsInstallments options
AvailablePaymentMethodsAvailable Payment Methods
RulesRules
InsertRuleInsert Rule
RuleDelete Rule
RuleByIdRule By Id
PutRuleByIdRule By Id
1_Createanewtransaction1.
TransactionDetailsTransaction Details
3_SendAdditionalData3.
4_DoauthorizationDo authorization
CancelthetransactionCancel the transaction
2_SendPaymentsWithSavedCreditCard2.2 Send Payments With Saved Credit Card
PaymentDetailsPayment Details
RefundthetransactionRefund the transaction
SettlethetransactionSettle the transaction
TransactionSettlementDetailsTransaction Settlement Details
On this Page