Skip to main content
O

Openpay

@codespar/mcp-openpay · v0.2.2

🇲🇽 MéxicoPagamentosAuth · API Keybeta23 ferramentas3 variáveis de ambiente

Gateway mexicano do BBVA — a alternativa MX à Conekta. Cartões, OXXO, SPEI, assinaturas (nativas), payouts de marketplace. Fecha a história das trilhas BBVA pro México.

Comece · grátisVer docs

MIT · roda localmente com as suas credenciais

Variáveis de ambiente, nomes e descrições das ferramentas vêm do pacote npm e ficam em inglês.

Pacote
@codespar/mcp-openpay
Versão
0.2.2
dist-tag npm
latest
Categoria
Pagamentos
Auth
API Key
País
🇲🇽 México
Licença
MIT
Transporte
stdio · streamable-http

Início rápido

Instale, configure as credenciais, faça a primeira chamada.

Escolha seu cliente. O servidor roda localmente via stdio, com as suas credenciais.

Adicione o servidor ao seu clienteUma entrada de configuração. Sem build, sem SDK.
Defina as variáveis de ambiente3 variáveis lidas pelo código deste servidor, listadas abaixo.
Reinicie e faça a primeira chamadaO agente pode chamar qualquer uma das 23 ferramentas. Comece por create_charge.
terminal
# Claude Code claude mcp add openpay -e OPENPAY_ENV=… -e OPENPAY_MERCHANT_ID=… -e OPENPAY_PRIVATE_KEY=… -- npx -y @codespar/mcp-openpay@0.2.2 # then: /mcp to confirm the server is connected
Variáveis de ambiente3 variáveis
OPENPAY_ENVEnvironment: 'sandbox' (default) or 'production'. Selects between https://sandbox-api.openpay.mx and https://api.openpay.mx.opcional
OPENPAY_MERCHANT_IDOpenpay merchant id (forms part of the API URL path)obrigatória
OPENPAY_PRIVATE_KEYOpenpay private API key (used as HTTP Basic auth username with empty password)obrigatóriasegredo

Nomes lidos do código do pacote (@codespar/mcp-openpay@0.2.2). Descrições e marcações vêm do manifesto dele. Auto-hospedado, você guarda as credenciais.

Primeira chamada democreate_charge

"Create a charge. Pass customer_id to charge at a customer scope"

tools/callcreate_chargeresultado devolvido

Ferramentas

O que o seu agente pode chamar.

23 ferramentas, como o tools/list do pacote as devolve.

create_charge

Create a charge. Pass customer_id to charge at a customer scope (POST /customers/{customer_id}/charges); omit to charge at merchant scope (POST /charges). Methods: 'card' (requires source_id token), 'bank_account' (SPEI — returns CLABE reference), 'store' (OXXO — returns barcode/reference). Amounts are in major units (e.g. 100 = 100 MXN).

get_charge

Retrieve a charge. Pass customer_id to fetch at customer scope (GET /customers/{customer_id}/charges/{id}); omit for merchant scope (GET /charges/{id}).

capture_charge

Capture a previously authorized charge (when the original charge used capture=false). Pass amount to capture less than the authorized total; omit to capture the full authorized amount.

refund_charge

Refund a captured charge. Supports partial refunds via amount; omit amount for a full refund.

create_customer

Create a customer record. Set requires_account=true to create an associated Openpay wallet for the customer; false for a payment-only record.

get_customer

Retrieve a customer by Openpay customer id.

list_customers

List customers with optional filters. All parameters are passed as query params.

create_card

Tokenize a card. Pass customer_id to attach to a stored customer (POST /customers/{customer_id}/cards); omit for a merchant-level token (POST /cards). Prefer tokenizing client-side with Openpay.js to avoid PCI scope.

delete_card

Delete a tokenized card. Pass customer_id to delete at customer scope (DELETE /customers/{customer_id}/cards/{id}); omit for merchant scope (DELETE /cards/{id}).

create_plan

Create a subscription plan. Plans are templates — use create_subscription to subscribe a customer.

create_subscription

Subscribe a customer to a plan. Requires a stored card (source_id) to charge on each cycle.

create_payout

Pay out MXN to a bank account. Used for marketplace seller payouts and cross-border settlement. Scope to a customer with customer_id (POST /customers/{customer_id}/payouts) or run at merchant scope (POST /payouts).

Nomes e descrições vêm do tools/list do pacote (@codespar/mcp-openpay@0.2.2). Um tipo (leitura, escrita, exclusão) só aparece quando o pacote anota suas ferramentas ou cada ferramenta foi verificada uma a uma; nenhum dos dois existe ainda para este servidor.

Compatibilidade

MCP é um protocolo. Qualquer cliente que o fale pode montar este servidor.

O runtime da CodeSpar não roteia este servidor. Monte-o no seu cliente via stdio · streamable-http.

Protocolo

Qualquer cliente MCP

stdio · streamable-http

Perguntas

Antes de instalar.

Como instalo o servidor MCP Openpay?

Rode npx -y @codespar/mcp-openpay@0.2.2 e adicione o bloco de configuração acima ao seu cliente MCP: Claude Code, Cursor, Claude Desktop, VS Code ou qualquer cliente compatível. Sem build, sem SDK.

O que meu agente pode fazer com Openpay?

Openpay expõe 23 ferramentas de pagamentos. Seu agente as chama diretamente; a lista completa está acima.

Como Openpay autentica, e como as credenciais são guardadas?

Openpay usa API Key. Auto-hospedado, você guarda as credenciais: o servidor as lê das variáveis de ambiente.

Como Openpay lida com mudanças na API do provedor?

Cada servidor tem versão própria no npm. O comando desta página fixa a 0.2.2, a versão cujas ferramentas estão listadas aqui; seu agente segue nela até você trocar a versão.

Openpay é open source? Como reporto um bug?

Sim. Openpay tem licença MIT e está publicado no npm como @codespar/mcp-openpay, com o código no GitHub (link no painel Detalhes). Reporte problemas no repositório do pacote; problemas de segurança vão para security@codespar.dev, e respondemos em até 24 horas.

Comece em segundos.

Adicione a configuração acima, defina as variáveis, e seu agente chama as ferramentas.

Comece em segundos demo
Adicione o servidor ao seu cliente com a configuração acima.
Defina as variáveis de ambiente listadas acima.
Peça ao seu agente a primeira chamada.
Openpay — MCP server · 23 tools | CodeSpar