Skip to main content

​
O que é a Plowf

A Plowf é uma plataforma para operar PIX e fluxos financeiros associados: você pode receber (cobranças PIX In), enviar (transferências PIX Out), gerenciar chaves PIX, acompanhar MEDs (Mecanismo Especial de Devolução) e ser notificado por webhooks quando o status dos eventos mudar. Tudo isso pode ser usado pelo painel web e automatizado pela API REST documentada nas seções seguintes deste site.

​
Painel

O ambiente principal fica em app.plowf.com. Por lá você acessa o dashboard, configurações da conta e a área de integrações (incluindo restrição por IP para a API).

​
Módulos e API

ÁreaO que fazNa API
Cobranças (PIX In)Gerar e acompanhar cobranças para recebimento via PIXEndpoints em /payments
Transferências (PIX Out)Enviar valores por PIX para terceirosEndpoints em /transfers
Chaves PIXCadastrar, consultar e remover chaves PIX da contaEndpoints em /pix-keys
MEDsListar, consultar e responder em processos de devoluçãoEndpoints em /meds
WebhooksReceber notificações em tempo real na sua URLCRUD em /webhooks e eventos documentados em Eventos do Webhook

​
Panorama da API

Esta API permite gerenciar transferências PIX Out, cobranças PIX In e demais recursos de forma programática.
  • Base URL: https://app.plowf.com/api/v1
  • Formato: JSON
  • Respostas de sucesso trazem o conteúdo dentro de um objeto data

​
Formato de resposta

{
  "data": {
    // dados da resposta
  }
}
Em listagens paginadas, a resposta inclui também links e meta: 
{
  "data": [...],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 10,
    "to": 10,
    "total": 100
  }
}

​
Códigos de status HTTP

​
status
number
  • 200 — Sucesso
  • 401 — Não autenticado
  • 403 — Não autorizado
  • 404 — Recurso não encontrado
  • 422 — Erro de validação
  • 500 — Erro interno do servidor

​
Observações

  1. Campos de data/datetime seguem ISO 8601 (ex.: 2024-01-01T12:00:00Z)
  2. Campos marcados como | null podem retornar null ou serem omitidos
  3. Status e tipos são strings com nomes dos enums (ex.: "PAID", "PIX")

​
Próximos passos

  1. Autenticação e segurança — token, IPs permitidos e visão geral dos webhooks
  2. Contexto para assistentes de IA — arquivos llms.txt e llms-full.txt
  3. Endpoints detalhados nos grupos Cobranças, Transferências, Chaves PIX, MEDs e Webhooks no menu

Autenticação e segurança

Bearer Token, lista de IPs e segurança dos webhooks.

Contexto para IA

Como usar a documentação em texto para modelos e ferramentas.