Skip to main content
P

PicPay

@codespar/mcp-picpay · v0.2.0-alpha.3

🇧🇷 BrasilPagamentosAuth · API Keybeta20 ferramentas3 variáveis de ambienteversão prévia

Carteira digital brasileira com mais de 60M de usuários. API de checkout para merchants pra pagamentos, planos de recorrência e assinaturas. Release alpha no npm — pagamentos core verificados, formatos do payload de recorrência pendentes de validação em sandbox.

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.

Limitações

  • A v0.2.0-alpha.3 é uma versão prévia; o npm não tem versão estável deste pacote.
  • Chamadas hospedadas com chave de teste não estão disponíveis: o runtime não registrou o comportamento deste provedor em teste (test venue unclassified).
Pacote
@codespar/mcp-picpay
Versão
0.2.0-alpha.3 · versão prévia
dist-tag npm
latest
Categoria
Pagamentos
Auth
API Key
País
🇧🇷 Brasil
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 20 ferramentas. Comece por create_payment.
terminal
# Claude Code claude mcp add picpay -e PICPAY_BASE_URL=… -e PICPAY_SELLER_TOKEN=… -e PICPAY_TOKEN=… -- npx -y @codespar/mcp-picpay@0.2.0-alpha.3 # then: /mcp to confirm the server is connected
Variáveis de ambiente3 variáveis
PICPAY_BASE_URLPicPay ecommerce API base URL. Defaults to https://appws.picpay.com/ecommerce/public.opcional
PICPAY_SELLER_TOKENPicPay seller token used to validate webhook callbacks (x-seller-token header)obrigatóriasegredo
PICPAY_TOKENPicPay merchant integration token (sent as x-picpay-token header)obrigatóriasegredo

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

Primeira chamada democreate_payment

"Create a PicPay checkout payment. Returns paymentUrl"

tools/callcreate_paymentresultado devolvido

Ferramentas

O que o seu agente pode chamar.

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

create_payment

Create a PicPay checkout payment. Returns paymentUrl (redirect the buyer to the PicPay app / web) and qrcode (content + base64 image). The buyer pays inside PicPay; your callbackUrl receives the status update. value is in BRL as a decimal number (e.g. 20.50).

get_payment_status

Get the status of a payment by referenceId. Typical statuses: created, expired, analysis, paid, completed, refunded, chargeback.

cancel_payment

Cancel a PicPay order. If the order is unpaid, it is voided. If already paid, this triggers a refund (requires merchant account balance to cover).

create_plan

Create a subscription plan (Recurrency API). Plans define the recurring amount, frequency, and trial.

list_plans

List all subscription plans registered for this merchant.

update_plan

Update an existing subscription plan.

delete_plan

Delete a subscription plan. Fails if the plan has active subscriptions.

create_subscription

Enroll a buyer in a subscription plan. Returns the subscription record and the buyer-facing authorization URL.

get_subscription

Retrieve a subscription by id.

cancel_subscription

Cancel an active subscription. Future recurring charges are stopped; past charges are not refunded automatically.

validate_notification

Verify that an incoming webhook callback came from PicPay by comparing the x-seller-token header against PICPAY_SELLER_TOKEN. Use this in your callback handler before trusting the payload, then call get_payment_status to fetch the authoritative status.

refund_payment

Refund a paid PicPay order, optionally partially. Unlike cancel_payment, this is the explicit refund endpoint and accepts a custom amount for partial refunds. The merchant wallet must have enough balance to cover the refund.

Nomes e descrições vêm do tools/list do pacote (@codespar/mcp-picpay@0.2.0-alpha.3). 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 codespar_discover lista as ferramentas deste servidor, mas um projeto com chave de teste ainda não consegue chamá-las: o runtime não registrou o que este provedor faz em modo de teste e recusa em vez de adivinhar.

Protocolo

Qualquer cliente MCP

stdio · streamable-http

Perguntas

Antes de instalar.

Como instalo o servidor MCP PicPay?

Rode npx -y @codespar/mcp-picpay@0.2.0-alpha.3 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 PicPay?

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

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

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

Como PicPay 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.0-alpha.3, a versão cujas ferramentas estão listadas aqui; seu agente segue nela até você trocar a versão.

PicPay é open source? Como reporto um bug?

Sim. PicPay tem licença MIT e está publicado no npm como @codespar/mcp-picpay, 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.
PicPay — MCP server · 20 tools | CodeSpar