Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.safefypay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Official package

The Safefy MCP Server implements the Model Context Protocol (MCP), allowing AI agents to interact with the Safefy API directly, without writing any integration code.

​
Requirements

  • Node.js 18 or higher

​
Setup by platform

Generate your credentials at app.safefypay.com.br/panel/merchant/api-credentials.
Edit your claude_desktop_config.json file:
{
  "mcpServers": {
    "safefy": {
      "command": "npx",
      "args": ["-y", "@safefypay/safefy-mcp"]
    }
  }
}
After saving, tell Claude: “Set up my Safefy credentials: public key pk_..., secret key sk_...”

​
Available tools

The MCP Server exposes the following tools to the AI agent:

​
Authentication

  • configure_credentials: Set public key and secret key
  • authenticate: Generate an access token

​
Transactions

  • create_transaction: Create a PIX or boleto charge
  • get_transaction: Get details of a transaction
  • list_transactions: List transactions with filters
  • simulate_transaction: Simulate confirmation/failure in Sandbox

​
Customers

  • create_customer: Create a customer
  • get_customer: Get customer by ID
  • list_customers: List customers with filters
  • update_customer: Update customer data

​
Balance

  • get_balance: Get available balance

​
Cashouts

  • create_cashout: Request a withdrawal
  • get_cashout: Get details of a cashout
  • list_cashouts: List cashouts with filters
  • cancel_cashout: Cancel a pending cashout
  • simulate_cashout: Simulate completion/failure in Sandbox
  • get_payment_link: Get payment link by ID
  • get_payment_link_status: Get status of a payment link
  • start_payment_link: Start a charge on a payment link

​
Orders

  • get_order: Get order by ID

​
Products

  • get_product: Get product by ID
  • list_products: List products with filters

​
Usage example

Once the MCP is configured, you can ask the AI agent: 
Create a PIX charge of R$ 150.00 for customer João Silva, CPF 123.456.789-00.
The agent will call create_transaction automatically and return the QR Code and PIX copy-and-paste code. 
List the last 10 transactions and show me the available balance.
The agent will call list_transactions and get_balance in parallel and present a summary.