vaultix_create_charge

Create payment charges for PIX, credit card, or boleto transactions in Brazilian currency. Specify amount in cents, customer details, and payment method to process payments.

Instructions

Create a new payment charge (PIX, Credit Card, or Boleto). Amount is in cents (e.g., 5000 = R$ 50,00)

Input Schema

TableJSON Schema

Name	Required	Description
`amount`	Yes	Amount in cents (minimum 100 = R$ 1,00)
`payment_method`	Yes	Payment method
`customer_name`	Yes	Customer name
`customer_email`	Yes	Customer email
`customer_document`	No	Customer CPF/CNPJ
`description`	No	Charge description

Implementation Reference

src/tools/index.ts:430-440 (handler)

The handler for the 'vaultix_create_charge' tool. It maps the input arguments to a POST request to the '/charges' endpoint using the VaultixClient.

case 'vaultix_create_charge':
  return client.post('/charges', {
    amount: args.amount,
    payment_method: args.payment_method,
    description: args.description,
    customer: {
      name: args.customer_name,
      email: args.customer_email,
      document: args.customer_document,
    },
  })

src/tools/index.ts:19-30 (schema)

Input schema defining the parameters and validation rules for the 'vaultix_create_charge' tool.

inputSchema: {
  type: 'object',
  properties: {
    amount: { type: 'number', description: 'Amount in cents (minimum 100 = R$ 1,00)' },
    payment_method: { type: 'string', enum: ['pix', 'credit_card', 'boleto'], description: 'Payment method' },
    customer_name: { type: 'string', description: 'Customer name' },
    customer_email: { type: 'string', description: 'Customer email' },
    customer_document: { type: 'string', description: 'Customer CPF/CNPJ' },
    description: { type: 'string', description: 'Charge description' },
  },
  required: ['amount', 'payment_method', 'customer_name', 'customer_email'],
},

src/tools/index.ts:17-30 (registration)

Registration of the 'vaultix_create_charge' tool in the exported tools array, including name, description, and schema.

name: 'vaultix_create_charge',
description: 'Create a new payment charge (PIX, Credit Card, or Boleto). Amount is in cents (e.g., 5000 = R$ 50,00)',
inputSchema: {
  type: 'object',
  properties: {
    amount: { type: 'number', description: 'Amount in cents (minimum 100 = R$ 1,00)' },
    payment_method: { type: 'string', enum: ['pix', 'credit_card', 'boleto'], description: 'Payment method' },
    customer_name: { type: 'string', description: 'Customer name' },
    customer_email: { type: 'string', description: 'Customer email' },
    customer_document: { type: 'string', description: 'Customer CPF/CNPJ' },
    description: { type: 'string', description: 'Charge description' },
  },
  required: ['amount', 'payment_method', 'customer_name', 'customer_email'],
},

Vaultix MCP Server