Skip to main content
PI

PicPay

v0.2.0-alpha.2API Keyalpha

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.

20 ferramentas3 env vars🇧🇷 Brasilalpha — validação pendente

O que seu agente faz

O PicPay dá ao seu agente 20 tools que ele chama direto — escolha as que precisar, no Claude, Cursor ou qualquer cliente MCP.

  • create_paymentCreate 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_statusGet the status of a payment by referenceId. Typical statuses: created, expired, analysis, paid, completed, refunded, chargeback.
  • cancel_paymentCancel a PicPay order. If the order is unpaid, it is voided. If already paid, this triggers a refund (requires merchant account balance to cover).
Exemplo de chamada
// Your agent calls a tool directly — no glue code.
// CodeSpar's managed tier handles OAuth2, token rotation and rate limits.
const result = await session.call("create_payment", { /* ... */ });

Instalar

terminal
$ npm install @codespar/mcp-picpay@alpha

Quickstart

Adicione esta entrada ao seu claude_desktop_config.json (ou a config de qualquer cliente compatível com MCP).

claude_desktop_config.json
{
  "mcpServers": {
    "picpay": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-picpay@alpha"
      ],
      "env": {
        "PICPAY_TOKEN": "<your_picpay_token>",
        "PICPAY_SELLER_TOKEN": "<your_picpay_seller_token>"
      }
    }
  }
}

Depois de reiniciar, seu agente pode chamar qualquer uma das 20 ferramentas abaixo — teste create_payment primeiro.

Variáveis de ambiente · 3

Necessárias pra autenticar o server. Armazenadas criptografadas ao usar a hospedagem gerenciada da CodeSpar.

PICPAY_TOKEN
obrigatóriosecret

PicPay merchant integration token (sent as x-picpay-token header)

PICPAY_SELLER_TOKEN
obrigatóriosecret

PicPay seller token used to validate webhook callbacks (x-seller-token header)

PICPAY_BASE_URL
opcional

PicPay ecommerce API base URL. Defaults to https://appws.picpay.com/ecommerce/public.

Ferramentas disponíveis · 20

Cada ferramenta é independente — seu agente carrega só o que precisa pra reduzir contexto e tempo de resposta.

WRITEcreate_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).
WRITEget_payment_status
Get the status of a payment by referenceId. Typical statuses: created, expired, analysis, paid, completed, refunded, chargeback.
DELETEcancel_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).
WRITEcreate_plan
Create a subscription plan (Recurrency API). Plans define the recurring amount, frequency, and trial.
READlist_plans
List all subscription plans registered for this merchant.
WRITEupdate_plan
Update an existing subscription plan.
DELETEdelete_plan
Delete a subscription plan. Fails if the plan has active subscriptions.
WRITEcreate_subscription
Enroll a buyer in a subscription plan. Returns the subscription record and the buyer-facing authorization URL.

Frameworks compatíveis

MCP é um protocolo — qualquer framework que o fale pode montar este server.

Claude Agent SDKAnthropic
OpenAI AgentsOpenAI
Vercel AI SDKVercel
LangChainLangChain
LlamaIndexLlamaIndex
CrewAICrewAI
MastraMastra
Qualquer cliente MCPProtocolo

Perguntas frequentes

Rode `npx -y @codespar/mcp-picpay` e adicione o bloco de config acima ao seu cliente MCP — Claude, Cursor, VS Code ou qualquer cliente compatível com MCP. Sem build, sem SDK. Prefere hospedado? O tier gerenciado da CodeSpar roda pra você, com a auth resolvida.
PicPay — MCP server · 20 tools | CodeSpar