FlashPay
EntrarCriar conta

Documentação da API

Integre pagamentos PIX em minutos. Endpoints REST simples, webhooks em tempo real.

🚀 Comece

Crie a conta e gere a chave

💸 Cobrar

POST /charges

🔔 Webhook

Receba notificações

▶️ Vídeo de integração (passo a passo, 3 min)

Em breve disponibilizamos um tutorial em vídeo aqui. Por enquanto, siga o passo a passo abaixo — está explicadinho.

Vídeo em produção 🎬

1. Crie sua conta

  1. Acesse /cadastro e cadastre seu e-mail e senha — entrada imediata, sem confirmação por e-mail.
  2. Vá em Mais → API e gere uma chave secreta (fk_sec_...). Guarde — só aparece uma vez.

2. Autenticação

Envie a chave secreta no header Authorization: Bearer fk_sec_... ou X-Api-Key: fk_sec_....

3. Criar cobrança PIX

POST https://flashpay.app/api/public/v1/charges

curl -X POST https://flashpay.app/api/public/v1/charges \
  -H "Authorization: Bearer fk_sec_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_cents": 1990,
    "description": "Pedido #1234",
    "customer_name": "João da Silva",
    "external_id": "pedido-1234"
  }'

Resposta:

{
  "id": "uuid-da-transacao",
  "status": "pending",
  "amount_cents": 1990,
  "fee_cents": 50,
  "net_cents": 1940,
  "pix": {
    "copy_paste": "00020126...",
    "qr_code_image": "data:image/png;base64,...",
    "expires_at": "2026-05-05T12:00:00Z"
  }
}

4. Parâmetros

  • amount_cents (obrigatório) — valor em centavos. Mín: 100 (R$ 1,00).
  • description — descrição da cobrança (até 200 caracteres).
  • customer_name — nome do cliente.
  • external_id — seu identificador interno (idempotência).

5. Webhook (notificação de pagamento)

Quando o cliente paga, enviamos um POST para a URL que você configurar no painel, com o status atualizado da transação.

{
  "event": "charge.paid",
  "transaction_id": "uuid",
  "external_id": "pedido-1234",
  "status": "paid",
  "amount_cents": 1990,
  "paid_at": "2026-05-05T12:01:23Z"
}

6. Status possíveis

  • pending — aguardando pagamento
  • paid — pago
  • expired — PIX expirou
  • failed — falha
  • refunded — estornado

7. Suas taxas (cálculo automático)

Entre na sua conta para ver suas taxas reais aqui.

fee_cents = pix_fee_cents + round(amount_cents × pix_fee_percent / 100)

net_cents = amount_cents − fee_cents

Exemplo com suas taxas — Venda de R$ 100,00

fee_cents = 50 + round(10000 × 0 / 100) = 50
net_cents = 10000 − 50 = 9950    // você recebe R$ 99,50

💡 A resposta da API já vem com fee_cents e net_cents calculados — basta contabilizar o net_cents como sua receita líquida.

8. UTM e atribuição (opcional)

Envie os parâmetros UTM e cookies do Meta na criação da cobrança para ter atribuição de venda no painel e disparar Meta Conversions API + UTMify automaticamente quando o PIX for pago:

curl -X POST https://flashpay.app/api/public/v1/charges \
  -H "Authorization: Bearer fk_sec_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_cents": 9700,
    "description": "Curso XPTO",
    "customer_name": "Maria",
    "customer_email": "maria@exemplo.com",
    "external_id": "pedido-9001",
    "tracking": {
      "utm_source": "facebook",
      "utm_campaign": "lancamento-out",
      "utm_content": "criativo-3",
      "fbp": "fb.1.1700000000000.1234567890",
      "fbc": "fb.1.1700000000000.AbCdEf"
    }
  }'