Ir para o conteúdo
Sharkpay

Documentação da API

Integre pagamentos, saques e webhooks ao seu sistema com uma API HTTP/JSON aberta e documentada.

API 2026-10-14

Visão geral e arquitetura

O SharkPay é um gateway de pagamentos com uma API HTTP/JSON aberta. Seu sistema cria cobranças e saques, consulta o resultado e recebe eventos assinados — sem depender de plataforma, SDK ou fornecedor específico.

Como funciona

  1. Você obtém as chaves no painel (chave pública + chave secreta) e troca por um token Bearer em POST /api/auth.
  2. Seu servidor cria a cobrança (Pix, boleto ou cartão) ou um saque Pix. O SharkPay reserva/valida os valores e aciona o provedor de pagamento habilitado na sua conta.
  3. O cliente paga pelo meio escolhido. O provedor avisa o SharkPay, que confirma o pagamento de forma atômica (sem crédito duplicado).
  4. Você é avisado por webhook assinado (invoice.paid, pixout.paid…) e pode conferir o estado a qualquer momento por consulta.

Arquitetura de integração

Fluxo
Seu sistema (backend)                      SharkPay                         Provedores
 ─────────────────────                      ────────                         ──────────
 POST /api/auth  ───────────────────────►   valida chaves, emite token
 POST /api/pix/create (Idempotency-Key) ►   cria cobrança  ───────────────►  banco / adquirente
                                            ◄───────────────  QR Code / boleto / autorização
 ◄── 200 {reference, copy, qrcode}
                                            ◄── notificação de pagamento ──  (callback do provedor, autenticado)
                                            confirma + registra no livro-razão
 ◄── webhook invoice.paid (assinado) ────
 GET /api/invoice/ref/{ref}  ───────────►   estado atual (fonte da verdade)
  • Sempre do servidor. A chave secreta e o token nunca devem existir em navegador ou app. Apps móveis falam com o seu backend, que fala com o SharkPay.
  • Formato. JSON em UTF-8 (Content-Type: application/json). Valores monetários são decimais com ponto ("190.00" nas respostas), na moeda da conta.
  • Fonte da verdade. O estado da cobrança no SharkPay. O redirecionamento do cliente ao seu site não prova pagamento.

Recursos disponíveis

RecursoO que fazEndpoints
Autenticação Troca chaves por token Bearer POST /api/auth
Cobranças Criar (Pix, boleto, cartão) e consultar /api/pix/create, /api/boleto/create, /api/creditcard/create, /api/invoice*, /api/invoices
Saques Pix Enviar dinheiro da sua conta por Pix /api/pixout/*
Clientes Cadastro de pagadores (necessário para boleto) /api/customer*
Checkout hospedado Página de pagamento do SharkPay, sem coletar dados no seu site POST /ext_transfer + GET /api/checkout/{tx_ref}
Webhooks Eventos assinados para o seu servidor /api/webhook*
Referência Países, estados e CEP /api/country/*, /api/state/*, /api/cep/search/{cep}