SviziaPayAPI v1Índice
Documentação
API da Svizia Pay
Receba por Pix em conta nominal no seu CPF/CNPJ, saque para você, pague contas, abra subcontas para as lojas da sua plataforma e confirme o documento de quem paga. REST com JSON, chaves por sistema e webhooks assinados.
Autenticação e permissões
Crie as chaves em Credenciais da API (uma por sistema; até 10). Mande no cabeçalho Authorization: Bearer <chave> ou x-api-key: <chave>. A chave completa aparece uma vez só, na criação.
svp_test_…: Gateway de Teste. Tudo simulado, saldo separado, dá para simular o pagamento.svp_live_…: produção. Só depois da aprovação da conta e com a verificação em 2 etapas ligada.
Cada chave tem permissões. Chamada fora da permissão volta 403.
| Campo | Tipo | O que é |
|---|---|---|
| pix | padrão | Cobranças, saldo, extrato e verificação de CPF/CNPJ |
| withdraw | opcional | Saques para o seu próprio CPF/CNPJ |
| payments | opcional | Pagar contas: Pix copia e cola, chave Pix de terceiros e boleto |
| shops | opcional | Criar e operar subcontas; cobrar em nome delas e dividir |
Formato e limites
- Corpo e resposta em JSON. Datas em ISO 8601 (UTC). Listas vêm em
{ "data": [...] }. - Mande
Idempotency-Keynos POST que criam algo: repetir o pedido com a mesma chave devolve o mesmo resultado, sem criar outro. - Limite padrão: 600 chamadas por minuto por chave (resposta 429 acima disso).
- Especificação completa em /api/v1/openapi.json: importe no Postman ou gere um SDK.
Sandbox, SDKs e Postman
Sandbox: a mesma API em https://sviziapay.com/sandbox/api/v1, que só aceita chave svp_test_. Nada real acontece por esse endereço, nem por engano com a chave errada. Na produção, troque só a base para https://sviziapay.com/api/v1 e a chave para svp_live_.
Kits prontos (um arquivo só, sem dependências), com todos os métodos e a conferência da assinatura do webhook: Node.js · Python · PHP.
import { SviziaPay } from "./sviziapay.mjs";
const svp = new SviziaPay(process.env.SVP_KEY, { sandbox: true });
const pix = await svp.createPix({ value: 1990, description: "Grupo VIP", payer: { name: "Ana", document: "12345678909" } });
// no webhook: const ev = SviziaPay.verifyWebhook(rawBody, req.headers["x-sviziapay-signature"], process.env.SVP_WEBHOOK_SECRET);from sviziapay import SviziaPay
svp = SviziaPay(os.environ["SVP_KEY"], sandbox=True)
pix = svp.create_pix({"value": 1990, "description": "Grupo VIP", "payer": {"name": "Ana", "document": "12345678909"}})require 'SviziaPay.php';
$svp = new SviziaPay(getenv('SVP_KEY'), ['sandbox' => true]);
$pix = $svp->createPix(['value' => 1990, 'description' => 'Grupo VIP', 'payer' => ['name' => 'Ana', 'document' => '12345678909']]);Postman: importe /api/v1/postman.json (já aponta para o sandbox) e preencha a variável apiKey. Para gerar um SDK de outra linguagem, use /api/v1/openapi.json.
Integre com IA
Vai pedir para o Claude, Cursor ou outro assistente fazer a integração? Passe o guia em texto, escrito para eles: endpoints, exemplos e as regras que não podem faltar (centavos, idempotência, assinatura do webhook).
Leia https://sviziapay.com/docs/ia.md e integre a Svizia Pay no meu sistema: criar o Pix no checkout, mostrar o QR e liberar o pedido no webhook charge.paid.
Criar cobrança
Gera o Pix com QR Code e copia e cola. Na produção a instituição pede nome e CPF/CNPJ de quem paga.
| Campo | Tipo | O que é |
|---|---|---|
| value | inteiro | Valor em centavos |
| description | texto | Aparece para quem paga (até 140) |
| external_id | texto | Seu id do pedido |
| webhook_url | https | Endereço só desta cobrança (opcional) |
| expires_in | minutos | Validade do QR (padrão 60) |
| payer | objeto | name, document, email, phone (o celular monta o link do WhatsApp na recuperação de Pix vencido) |
| buyer | objeto | Anti-MED: ip e user_agent (site) ou id do comprador (bot do Telegram/WhatsApp) |
| shop_id | texto | Cobrar em nome de uma subconta (veja Subcontas) |
| splits | lista | Dividir com subcontas (veja Subcontas) |
curl https://sviziapay.com/api/v1/pix/cashin \
-H "Authorization: Bearer svp_test_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-123" \
-d '{
"value": 1990,
"description": "Curso de bolo",
"external_id": "pedido-123",
"payer": { "name": "Ana Souza", "document": "39053344705" }
}'{
"id": "k3f9...", "status": "pending", "value": 1990, "fee": 99, "net": null,
"description": "Curso de bolo", "external_id": "pedido-123",
"qr_code": "00020126...6304ABCD", "qr_code_base64": "data:image/png;base64,...",
"payer": { "name": "Ana Souza", "document": "39053344705" },
"paid_by": null, "end_to_end_id": null, "refunded": 0, "test": true,
"expires_at": "2026-10-02T22:00:00.000Z", "paid_at": null, "created_at": "2026-10-02T21:00:00.000Z", "receipt_url": null
}Página de pagamento pronta: https://sviziapay.com/p/<id> (QR, copia e cola e confirmação ao vivo).
Análise anti-MED: antes de gerar, conferimos o comprador e o aparelho (mande payer sempre que tiver). Risco alto = 403 e o Pix não sai. Risco médio = o Pix sai com "risk": { "level": "medium", "reasons": [...] } — segure a entrega e confirme com o comprador. Depois de pago, se quem pagou não for o comprador informado, o charge.paid já chega com risk.level "medium".
Consultar cobrança
Situações: pending, paid, expired, cancelled, refunded, med (denúncia de golpe, valor preso), returned (MED aceito).
Listar cobranças
Mais novas primeiro. Para a próxima página, mande em before o created_at da última.
Devolver
Devolve a quem pagou. Sem corpo, devolve tudo (ou o que falta). Com value, devolve só uma parte (várias parciais podem somar até o valor pago; venda com divisão só aceita devolução total). Sai do seu saldo; as taxas não voltam. Devolver antes de o comprador abrir MED protege a sua taxa de MED.
| Campo | Tipo | O que é |
|---|---|---|
| value | centavos | Quanto devolver (opcional; padrão: o que falta) |
Recuperar Pix vencido
O comprador gerou o Pix e não pagou? Gere um Pix novo para a mesma pessoa, com desconto opcional, e receba a mensagem pronta para o seu bot mandar no Telegram ou no WhatsApp (e o link wa.me quando a compra tem celular). Chamar de novo devolve o mesmo Pix novo, sem duplicar. Pix de link com a recuperação ligada já sai sozinho e chega no webhook charge.recovery.
| Campo | Tipo | O que é |
|---|---|---|
| discount_percent | 0 a 50 | Desconto sobre o item principal (opcional) |
| expires_in_minutes | 10 a 10080 | Validade do Pix novo (padrão 24 h) |
{ "discount_percent": 10 }
→ 200 { "id": "...", "status": "pending", "value": 1791, "qr_code": "000201...", "recovered_from": "...", "reused": false,
"payment_url": "https://sviziapay.com/p/...", "message": "Oi, Ana! Seu Pix de Grupo VIP venceu... ", "whatsapp_url": "https://wa.me/55..." }Simular pagamento
Só com a chave de teste: marca como pago e dispara o webhook charge.paid, como na produção.
Informar entrega
Diga quando e como entregou (o bot liberou o grupo, o curso foi enviado, o pedido saiu). Vira prova no dossiê e entra sozinha na defesa automática de MED: se alguém contestar o Pix, mandamos a defesa com essas entregas. Até 20 por venda.
| Campo | Tipo | O que é |
|---|---|---|
| how | texto | O que foi entregue e para quem (3 a 140) |
| details | texto | Detalhes: rastreio, conversa, convite (opcional) |
| url | https | Link da prova (opcional) |
| at | ISO 8601 | Quando entregou (padrão: agora) |
{ "how": "acesso ao grupo VIP liberado para @joao", "details": "convite aceito às 21:04" }
→ 201 { "id": "k3f9...", "delivery": [{ "at": "2026-10-02T21:04:00.000Z", "how": "acesso ao grupo VIP liberado para @joao", "via": "api", ... }] }Criar assinatura
Grupo VIP mensal, clube, comunidade: cria a assinatura e já devolve o 1º Pix (mesmos campos de uma cobrança, em charge). A cada ciclo sai um Pix novo sozinho, 3 dias antes de vencer: mandamos por e-mail ao assinante e para o seu webhook (subscription.renewal, com charge.qr_code para o bot mandar no Telegram). Não é débito automático: o assinante paga cada Pix.
| Campo | Tipo | O que é |
|---|---|---|
| value | centavos | Valor de cada ciclo |
| interval_days | 7 | 30 | 90 | 365 | Semanal, mensal, trimestral ou anual |
| description | texto | O que é cobrado (aparece para o assinante) |
| payer | objeto | name, document (obrigatórios), email (recomendado: o Pix de cada ciclo chega lá), phone |
| external_id | texto | Seu id (ex.: id do usuário no bot); dá para consultar e cancelar por ele |
| webhook_url | https | Endereço dos eventos desta assinatura (opcional) |
{ "value": 2990, "interval_days": 30, "description": "Grupo VIP", "external_id": "tg_5521",
"payer": { "name": "Ana Lima", "document": "39053344705", "email": "[email protected]" } }
→ 201 { "id": "s8k2...", "status": "pending", "value": 2990, "interval_days": 30, "paid_until": null,
"manage_url": "https://sviziapay.com/assinatura/...", "charge": { "id": "c91...", "qr_code": "00020126...", ... } }Eventos: subscription.active (1º pagamento: libere o acesso), subscription.renewal (Pix da renovação gerado), subscription.reminder (lembrete 1 dia antes, no dia e 1 dia antes de cancelar, com stage, message e whatsapp_url), subscription.renewed, subscription.past_due (venceu sem pagar; 3 dias de carência), subscription.cancel_scheduled, subscription.cancelled (tire o acesso) e subscription.auto_pay (Pix Automático: auto_pay.status active, refused, cancelled ou expired). Onde a instituição oferece Pix Automático, o 1º Pix também pede ao comprador para autorizar os débitos no banco; com a autorização ativa, a renovação é debitada sozinha (o subscription.renewal vem com auto_debit: true e não precisa mandar o Pix). Recusou ou o débito falhou: volta sozinho para o Pix de cada ciclo. Cada Pix também dispara os eventos normais (charge.paid…). O assinante vê e cancela em manage_url.
Listar e consultar
{id} aceita o id ou o seu external_id. Situações: pending (esperando o 1º Pix), active, past_due, cancelled, incomplete (o 1º Pix venceu). A lista traz também summary com a receita por mês.
Cancelar
Padrão: continua até o fim do período pago e não renova. { "immediately": true } cancela agora.
Saldo
{ "available": 970200, "blocked": 0, "test": false }blocked = valor preso por MED até o banco de quem pagou decidir.
Sacar
Pix para a chave do seu próprio CPF/CNPJ, nunca para terceiros. A instituição confere o destino antes de liberar.
{ "value": 50000 }
→ 201 { "id": "...", "status": "processing", "value": 50000, "fee": 0, "pix_key_type": "CPF" }Consultar saques
Situações: pending, processing, done, failed. Saque que falha devolve o valor ao saldo.
Conferir antes de pagar
Mostra quem recebe e quanto, sem mover dinheiro. Use para pedir a confirmação do usuário.
| Campo | Tipo | O que é |
|---|---|---|
| kind | pix_qr | pix_key | bill | Pix copia e cola, chave Pix ou linha digitável do boleto |
| target | texto | O código, a chave ou a linha digitável |
{ "kind": "bill", "target": "34191.79001 01043.510047 91020.150008 1 95870000010000" }
→ { "kind": "bill", "value": 10000, "can_change_value": false,
"receiver": { "name": "Energia SA", "document": "**.***.***/0001-**" },
"bank": "Banco do Brasil", "due_date": "2026-10-10", "key_type": null }Pagar
Paga do seu saldo. Para pix_key mande value; no QR e no boleto o valor vem do próprio código (mande igual). Limite de 24 h configurado pela Svizia Pay; valor preso por MED não pode ser usado.
{ "kind": "pix_key", "target": "[email protected]", "value": 25000, "description": "Frete" }
→ 201 { "id": "...", "kind": "pix_key", "status": "processing", "value": 25000, "fee": 0,
"receiver": { "name": "Transportes Lima", "document": "***.456.789-**" } }Situações: processing, done, failed (o valor volta). Eventos payment.done e payment.failed.
Consultar pagamentos
Os 50 mais novos, ou um pelo id.
Criar subconta
Para plataformas: cada loja ganha a própria conta nominal no CPF/CNPJ dela, com cadastro e aprovação próprios. Os eventos das subcontas chegam no seu webhook com shop_id.
| Campo | Tipo | O que é |
|---|---|---|
| texto | E-mail do responsável pela loja | |
| external_ref | texto | Seu id da loja (dá para usar no lugar do id) |
| personType | PF | PJ | Pessoa física ou jurídica |
| document | texto | CPF ou CNPJ |
| legalName | texto | Nome completo ou razão social |
| birthDate | AAAA-MM-DD | Obrigatório para PF |
| companyType | MEI | LIMITED | INDIVIDUAL | ASSOCIATION | Obrigatório para PJ |
| phone, postalCode, address, addressNumber, province | texto | Contato e endereço |
| incomeCents | inteiro | Faturamento ou renda mensal, em centavos |
| niche | texto | O que a loja vende |
{ "id": "q8r2...", "external_ref": "loja-42", "status": "review", "name": "Doces da Bia",
"document": "***.456.789-**", "person_type": "PF", "onboarding_url": null, ... }Listar e consultar subcontas
Situações: review, active, rejected, blocked. Evento shop.status quando muda.
Cobrar em nome da loja e dividir
shop_id faz a loja receber (id ou external_ref). splits divide o valor na hora, direto na conta de cada um: percent ou amount (centavos), até 5. Use "parent" para a sua comissão.
{
"value": 10000,
"shop_id": "loja-42",
"splits": [{ "shop_id": "parent", "percent": 10 }]
}Saldo, extrato e saque da subconta
Saque com POST /api/v1/shops/{id}/withdraw e { "value": 5000 } (precisa também da permissão withdraw). Vai sempre para a chave Pix do CPF/CNPJ da própria loja.
Verificar CPF/CNPJ
Confirma que a pessoa é dona do documento: geramos um Pix pequeno, ela paga do próprio banco e conferimos o CPF/CNPJ de quem pagou. O valor entra no seu saldo.
{ "document": "39053344705", "name": "Ana Souza", "external_id": "cliente-9" }
→ 201 { "id": "...", "status": "pending", "value": 200, "qr_code": "000201...",
"payment_link": "https://sviziapay.com/p/...", "document": "***.533.447-**" }Resultado da verificação
| Campo | Tipo | O que é |
|---|---|---|
| verified | Pagou do documento informado | |
| mismatch | Pagou de outro CPF/CNPJ (paid_by mostra qual, mascarado) | |
| paid_unknown | Pagou, mas o banco não informou o documento | |
| expired | Não pagou a tempo |
Evento kyc.verified quando sai o resultado.
Webhooks
Enviamos POST para o webhook_url da cobrança e para cada endereço cadastrado em Webhooks que assina o evento. Só https.
| Campo | Tipo | O que é |
|---|---|---|
| charge.paid | Pix pago | |
| charge.expired | Venceu sem pagamento | |
| charge.recovery | O Pix vencido ganhou um Pix novo: traz o Pix, a mensagem pronta e o link do WhatsApp para o bot mandar | |
| charge.reminder | Pix com vencimento de 2 dias ou mais vence em menos de 24 h: traz a mensagem e o link do WhatsApp | |
| charge.refunded | Devolvido a quem pagou | |
| charge.partially_refunded | Parte devolvida (refunded = total já devolvido) | |
| charge.claim | Comprador pediu ajuda na Central do comprador (devolva antes de virar MED) | |
| charge.med | Denúncia de golpe: valor preso (a defesa sai sozinha com o dossiê) | |
| charge.med_released | MED negado: valor liberado | |
| charge.med_returned | MED aceito: valor devolvido | |
| withdrawal.done / .failed | Saque concluído ou não | |
| payment.done / .failed | Conta paga ou não | |
| kyc.verified | Verificação concluída | |
| shop.status | Subconta mudou de situação |
POST /webhooks/svizia
X-SviziaPay-Event: charge.paid
X-SviziaPay-Delivery: 9z...
X-SviziaPay-Signature: t=1759450000,v1=5f2c...
{ "id": "9z...", "event": "charge.paid", "created_at": "...", "data": { ...igual ao GET... } }Responda 2xx em até 10 s. Se falhar, tentamos de novo em 1 min, 5 min, 15 min, 1 h, 3 h, 6 h, 12 h e 24 h, e dá para reenviar pelo painel. O mesmo evento pode chegar mais de uma vez: use o id para não processar duas vezes.
Conferir a assinatura
HMAC-SHA256(segredo, t + "." + corpo_cru) tem que ser igual ao v1. Use o corpo exatamente como chegou, antes de converter o JSON.
import crypto from "node:crypto";
const [t, v1] = req.headers["x-sviziapay-signature"].split(",").map((p) => p.split("=")[1]);
const esperado = crypto.createHmac("sha256", process.env.SVIZIA_WEBHOOK_SECRET).update(`${t}.${rawBody}`).digest("hex");
const ok = crypto.timingSafeEqual(Buffer.from(esperado), Buffer.from(v1));[$t, $v1] = array_map(fn($p) => explode("=", $p)[1], explode(",", $_SERVER["HTTP_X_SVIZIAPAY_SIGNATURE"]));
$ok = hash_equals(hash_hmac("sha256", "$t." . file_get_contents("php://input"), getenv("SVIZIA_WEBHOOK_SECRET")), $v1);Migrar de outro gateway sem reescrever o bot
O seu bot ou checkout já fala com a PushinPay, a SyncPay, a NexusPag/Atenas Pay ou a WiinPay? Troque só a URL base e a chave: os caminhos, os campos e os avisos (webhooks) seguem os de lá, e o dinheiro cai na sua conta nominal na Svizia Pay. A chave é uma svp_live_ (ou svp_test_ para testar) com a permissão Cobranças Pix. Todas também funcionam no sandbox (https://sviziapay.com/sandbox/api/compat/…). Na conta no Asaas a instituição exige nome e CPF de quem paga: mande no campo de cliente de cada uma.
PushinPay
Troque só a URL base e o token. Os caminhos, os campos (valor em centavos) e as respostas seguem os da PushinPay, e o dinheiro cai na sua conta nominal na Svizia Pay. O token é uma chave svp_live_ (ou svp_test_ para testar) com a permissão Cobranças Pix.
https://api.pushinpay.com.br → https://sviziapay.com/api/compat/pushinpay
POST /api/pix/cashIn { "value": 990, "webhook_url": "https://seu-bot/webhook" }
GET /api/transactions/{id} status: created | paid | canceled | refunded
POST /api/transactions/{id}/refund
GET /api/balance { "amount": 12345, "blocked_balance": "0" }O webhook vai em JSON com os mesmos nomes de campo (id, status, value, end_to_end_id, payer_name, payer_national_registration), assinado no cabeçalho X-SviziaPay-Signature. Na conta no Asaas a instituição exige quem paga: mande também payer: { name, document }. Opcional: buyer_id (id do comprador no bot) liga o anti-MED. A taxa de uma plataforma parceira vai em split_rules, igual à PushinPay (ver Plataformas parceiras). Divisão entre subcontas: use /api/v1.
SyncPay
https://api.syncpayments.com.br → https://sviziapay.com/api/compat/syncpay
POST /api/partner/v1/auth-token { "client_id": "qualquer", "client_secret": "svp_live_…" } → access_token
POST /api/partner/v1/cash-in { "amount": 19.90, "client": { "name", "cpf" } } → { pix_code, identifier }
GET /api/partner/v1/transaction/{identifier} status: pending | completed | expired | refunded
POST /api/partner/v1/transaction/{id}/refund
GET /api/partner/v1/balance { "balance": "90.00" }
GET|POST /api/partner/v1/webhooks registra o endereço dos avisos (como na SyncPay)Valores em reais. O aviso vai para o webhook_url do cash-in ou, sem ele, para o webhook registrado, no formato da SyncPay ({ data: { id, identifier, status: "completed", amount, final_amount } }) com Authorization: Bearer <token do registro>. A taxa da plataforma vai em split: [{ percentage, user_id }] (user_id = conta parceira; vira centavos e nunca passa da taxa combinada).
NexusPag e Atenas Pay
https://nexuspag.com → https://sviziapay.com/api/compat/nexuspag
https://atenaspay.com.br → https://sviziapay.com/api/compat/atenaspay (mesma API)
x-api-key: svp_live_…
POST /api/pix/create { "amount": 50.00, "external_id": "pedido-123", "webhook_url": "…", "customer": { "name", "document" } }
→ 201 { success, transaction: { id, pix_copia_cola, qr_code_base64, status } }
GET /api/pix/{id} (id ou external_id) status: pending | paid | expired | refunded
GET /api/walletValores em reais; external_id repetido devolve a mesma transação. O aviso é o da NexusPag ({ event: "payment.confirmed", transaction_id, status: "paid", amount, net_amount, fee }, e refund.completed) assinado em x-webhook-signature: t=…,v1=HMAC-SHA256(segredo, t.corpo) com o seu segredo de webhook. Taxa da plataforma: split: [{ user_id, amount }] em reais.
WiinPay
https://api-v2.wiinpay.com.br → https://sviziapay.com/api/compat/wiinpay
POST /payment/create { "api_key": "svp_live_…", "value": 19.90, "name", "email", "webhook_url": "…" }
→ 201 { data: { qr_code, paymentId } }
GET /payment/list/{paymentId} (Authorization: Bearer svp_live_…) status: PENDING | PAID | EXPIRED | REFUNDEDValor em reais. O aviso vai como na WiinPay ({ data: { paymentId, status: "PAID", value } }, valor bruto). Taxa da plataforma: split: { value, user_id } em reais. Para o anti-MED, mande também document (CPF de quem paga) e buyer_id.
Plataformas parceiras (bots e checkouts)
Para plataformas que criam Pix na conta de vários vendedores (ex.: um bot de vendas no Telegram) e cobram uma taxa por venda. A plataforma tem conta na Svizia Pay e a taxa por venda é combinada com a gente. O vendedor cria uma chave de API em Credenciais escolhendo a plataforma e cola nela: todo Pix gerado com essa chave leva a nossa taxa e a da plataforma pelo split, direto na conta nominal dela. Nada muda na chamada. Se o vendedor colar uma chave comum, a plataforma pode mandar a chave de parceiro dela no cabeçalho X-Partner-Key. Vendas que o vendedor faz por fora não levam nada.
POST https://sviziapay.com/api/v1/pix/cashin
Authorization: Bearer svp_live_… (chave do vendedor criada para a plataforma)
X-Partner-Key: svpp_… (opcional: só se a chave for comum)
{ "value": 2990, "webhook_url": "https://sua-plataforma/webhook" }Ou do jeito que os bots já fazem nos outros gateways: a taxa no corpo do Pix, no formato da PushinPay. account_id é o id da conta da plataforma na Svizia Pay (aparece em Integrações, na conta da plataforma) e value é a taxa em centavos, até a combinada com a Svizia Pay. Vale em /api/v1/pix/cashin e no cashIn compatível. Conta que não é parceira ou valor acima da combinada = 400.
POST https://sviziapay.com/api/compat/pushinpay/api/pix/cashIn
Authorization: Bearer svp_live_… (chave do vendedor)
{ "value": 2990, "webhook_url": "https://sua-plataforma/webhook",
"split_rules": [{ "value": 50, "account_id": "<id da plataforma>" }] }Vale também na camada compatível com a PushinPay (/api/compat/pushinpay/api/pix/cashIn). A taxa por venda é combinada com a Svizia Pay e a chave de parceiro é gerada em Integrações na conta da plataforma. Chave errada = 401. Na conta real a divisão é interna da instituição: plataforma e vendedor precisam estar na mesma.
MCP (Claude e outras IAs)
Servidor MCP (Streamable HTTP) em https://sviziapay.com/api/mcp/loja com Authorization: Bearer svp_…, ou https://sviziapay.com/api/mcp/loja/<chave> no conector do claude.ai. Chave de teste = dados de teste. Não saca, não paga contas e não devolve.
| Campo | Tipo | O que é |
|---|---|---|
| Conta | account (situação, taxas, limites, saúde da conta, etapa do cadastro), ranking (posição no mês e marcos) | |
| Vendas | balance, sales_report, charges, charge, create_charge, cancel_charge, statement, withdrawals, payments_out, med_status, buyer_claims, subscriptions | |
| Configurar | products, save_product (preço, order bumps, upsell, assinatura, afiliados, recuperação), coupons, save_coupon, coupon_active, create_subscription, cancel_subscription, coproductions, affiliates | |
| Inteligência | funnel (visitas → Pix → pago e tempo até pagar), buyers (recompra, valor por comprador, coortes), opportunities (com valor em R$, meta e alertas), set_goal, api_requests (registro das chamadas à API), cash_forecast, ab_test | |
| Regras e proteção | rules, save_automation (criar, editar, apagar), test_risk_rule, save_risk_rule (com modo teste), blocked_payers, block_payer, release_delivery | |
| Integração | integration_status, webhook_deliveries, charge_events, test_webhook, redeliver_webhooks, save_webhook_endpoint, webhook_events, partner_info, simulate_payment (só teste) | |
| Pós-venda | add_delivery (prova contra MED), answer_claim, recover_charge (Pix novo para quem não pagou) | |
| Prompts | configurar_minha_loja, diagnosticar_integracao, onde_estou_perdendo_vendas, resumo_da_semana |
App que só roda MCP local (stdio)? Use o pacote sviziapay-mcp: npx -y sviziapay-mcp com a variável SVIZIAPAY_KEY.
Plataformas parceiras (bots e sistemas que geram o Pix para os vendedores e ganham uma taxa por venda): https://sviziapay.com/api/mcp/parceiro com Authorization: Bearer svpp_… (ou /api/mcp/parceiro/<chave>). Só leitura: overview, sellers, sales, earnings, seller_health, integration_guide. Sem dados de comprador.
Erros
Corpo { "error": "mensagem" }, já em português, pronta para mostrar.
| Campo | Tipo | O que é |
|---|---|---|
| 400 | Dados inválidos | |
| 401 | Chave inválida ou ausente | |
| 403 | Sem permissão (chave sem o escopo, conta não aprovada ou bloqueada) | |
| 404 | Não encontrado | |
| 409 | O estado não permite (sem saldo, já pago, valor preso) | |
| 429 | Limite de chamadas | |
| 502 | Instituição indisponível: tente de novo |