Pular para o conteúdo
LeonaPayLeonaPayDevelopers
Primeiros passosReferenciais da APIIntegraçõesv2
Model Context Protocol

MCP da LeonaPay

Conecte agentes e IDEs à API LeonaPay usando ferramentas autenticadas e sem acesso direto ao banco.

Endpoint e autenticação

Use Streamable HTTP e envie a chave LeonaPay como Bearer. Para Sandbox acrescente ?environment=sandbox.
URL: https://mcp.leonapay.com.br/mcp
Authorization: Bearer {your_api_key}
Sandbox: https://mcp.leonapay.com.br/mcp?environment=sandbox

Configuração do cliente

Clientes que aceitam headers podem usar a configuração abaixo.
{
  "mcpServers": {
    "leonapay": {
      "url": "https://mcp.leonapay.com.br/mcp",
      "headers": { "Authorization": "Bearer {your_api_key}" }
    }
  }
}

Ferramentas disponíveis

Todas chamam somente endpoints públicos da API v2.
ToolOperação
onpay_get_startedExplicar o fluxo recomendado
onpay_list_payment_methodsListar métodos e moedas
onpay_get_companyConsultar empresa/KYC
onpay_get_balanceConsultar saldos
onpay_create_paymentCriar pagamento, incluindo boleto
onpay_get_paymentConsultar pagamento
onpay_get_transactionConsultar transação
onpay_list_customersPesquisar clientes
onpay_request_withdrawalSolicitar saque com controles de IP
onpay_list_webhooksListar webhooks
onpay_create_webhookCriar webhook
onpay_update_webhookEditar webhook
onpay_delete_webhookExcluir webhook

Confirmação de operações financeiras

As ferramentas de criação de pagamento e saque exigem confirmation: "CONFIRMAR". Isso deixa explícito para o agente que a chamada produz uma operação financeira. A idempotência pode ser informada ou gerada pela ferramenta.
{
  "method": "BOLETO",
  "amount": 125.90,
  "currency": "BRL",
  "reference": "pedido-123",
  "confirmation": "CONFIRMAR",
  "payer": { "name": "Ana Souza", "taxId": "12345678909" }
}

Segurança

O MCP é stateless, não consulta banco diretamente, nunca devolve a chave e aplica limite por chave e IP. Use Sandbox no desenvolvimento.
As validações, permissões, IP permitido para saques, limites e idempotência da API continuam valendo.
LeonaPay Developers · API v2