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

Limitações e roadmap

Transparência técnica: o que a API não faz hoje. Nada listado como “planejado” está disponível — não construa sua integração sobre isso.

Não existe hoje

RecursoSituaçãoAlternativa
Ambiente sandbox compartilhado Não existe Instalação de homologação com chaves próprias (veja Teste e produção).
Reembolso e cancelamento por API Não existe Feito pela administração; você é avisado por webhook (invoice.refunded / invoice.canceled).
Escopos/permissões por token Não existe O token tem acesso integral à conta; proteja-o como a chave.
Revogação de token por API Não existe Rotacione as chaves no painel (invalida os acessos).
Assinaturas / cobrança recorrente Não existe Crie uma cobrança por ciclo a partir do seu agendador.
Split de pagamento / marketplace Não existe Divisão feita no seu sistema.
Consulta de saldo e extrato por API Não existe Painel.
Eventos para todos os estados intermediários Parcial Somente os tipos listados em Webhooks.
SDKs oficiais Não existe Gere clientes pelo OpenAPI ou use os exemplos.
Boleto e cartão via PayGate Não existe A documentação pública do PayGate cobre apenas PIX; use outro adquirente para boleto/cartão (veja Adquirentes).
Filtro por status em /api/invoices Não existe Filtre no cliente ou use start_date/end_date.

Comportamentos a conhecer

  • Pix, boleto e cartão dependem de provedores configurados na instalação. Sem eles, a criação responde 400 “método não habilitado”.
  • A entrega de webhooks é pelo menos uma vez e sem garantia de ordem.
  • Nomes legados (loquidAmount, entoend, custome_id) permanecem por compatibilidade.
  • Os endpoints de “Pix bruto” (/api/pix/invoice, /api/pix/txid) devolvem o registro interno e seu formato pode mudar; prefira /api/invoice/ref/{ref}.
  • Os endpoints “Interno” (originalbank) não são parte da integração de comerciantes.

Planejado (futuro — ainda não implementado)

  • Reembolso e cancelamento por API (com Idempotency-Key e webhook correspondente).
  • Tokens com escopos e revogação.
  • Ambiente de teste (sandbox) isolado.
  • Eventos adicionais (por exemplo, expiração de Pix).

Não há datas prometidas. Quando algo for lançado, aparecerá primeiro no changelog e no OpenAPI.