Vaultix

Provides an MCP server to interact with Vaultix payments, enabling charges, customers, refunds, and other actions.

javascript

0

GitHub Stars

javascript

Language

6 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "vautlixdevelopment-mcpvaultix": {
      "command": "npx",
      "args": [
        "-y",
        "github:VautlixDevelopment/mcpVaultix"
      ],
      "env": {
        "VAULTIX_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}

You deploy the Vaultix MCP Server to let Claude interact directly with your Vaultix account, performing actions like creating charges, managing customers, and querying balances or transactions through a dedicated MCP endpoint.

How to use

Once your Vaultix MCP Server is up, configure your MCP client to connect using the provided runtime options. Use the server to issue standard MCP actions such as creating charges, retrieving charges, managing customers, processing refunds, checking balances, and handling orders, transactions, and payout-related activities. Your client sends requests to the Vaultix MCP Server, which communicates with Vaultix APIs to perform the requested operations and returns results for you to display or log.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Option 1 – Install from GitHub and use the MCP server directly via npx.

npm install -g github:VautlixDevelopment/mcpVaultix

Option 2 – Clone the repository locally, install dependencies, and build before running.

git clone https://github.com/VautlixDevelopment/mcpVaultix.git
cd mcpVaultix
npm install
npm run build

Available tools

vaultix_create_charge

Create a new charge for payment methods such as PIX, Card, or Boleto.

vaultix_get_charge

Retrieve a charge by its ID.

vaultix_list_charges

List all charges.

vaultix_cancel_charge

Cancel a pending charge.

vaultix_create_customer

Create a new Vaultix customer.

vaultix_get_customer

Get a customer by ID.

vaultix_list_customers

List all customers.

vaultix_update_customer

Update a customer's details.

vaultix_delete_customer

Delete a customer.

vaultix_create_refund

Create a refund for a specific charge.

vaultix_get_refund

Get a refund by ID.

vaultix_list_refunds

List all refunds.

vaultix_get_balance

Get the current Vaultix balance.

vaultix_list_balance_transactions

List balance-related transactions.

vaultix_create_product

Create a product in Vaultix.

vaultix_get_product

Get a product by ID.

vaultix_list_products

List all products.

vaultix_update_product

Update a product.

vaultix_delete_product

Delete a product.

vaultix_get_order

Get an order by ID.

vaultix_list_orders

List all orders.

vaultix_get_transaction

Get a transaction by ID.

vaultix_list_transactions

List all transactions.

vaultix_get_transactions_summary

Get a summary of transactions.

vaultix_create_payment_link

Create a payment link.

vaultix_get_payment_link

Get a payment link by ID.

vaultix_list_payment_links

List all payment links.

vaultix_deactivate_payment_link

Deactivate a payment link.

vaultix_create_payout

Create a payout (PIX or bank transfer).

vaultix_get_payout

Get a payout by ID.

vaultix_list_payouts

List all payouts.

vaultix_cancel_payout

Cancel a pending payout.