Documentacao da API

FlashPays API

Integre pagamentos PIX e cartao na sua aplicacao em minutos. Uma API REST moderna, com autenticacao JWT, webhooks em tempo real e suporte a multiplos provedores.

Base URL
http://localhost:8080/api/v1/

Recursos principais

PIX QR Code

Gere cobranças PIX com QR code dinâmico e receba confirmação em tempo real via webhook.

Cartão tokenizado

Processe cobranças em cartão de crédito com tokenização segura e captura automática.

Webhooks em tempo real

Receba notificações instantâneas sobre mudanças de status em cobranças e pagamentos.

Multi-provedor

Conecte Asaas, Mercado Pago e outros provedores sob uma API unificada.

Rate Limiting

120 req/min por usuario, headers padrao X-RateLimit-* em todas as respostas.

Fluxo de autenticacao

Toda requisicao autenticada requer um token JWT no header Authorization: Bearer <token>.

1

Crie suas credenciais

Registre-se ou receba um convite. Suas credenciais sao email + senha.

2

Troque por um JWT

Envie POST /auth/login com email e senha. Receba um token JWT valido.

3

Use nos endpoints

Passe o JWT em Authorization: Bearer <token> em todas as chamadas protegidas.

curl -X POST http://localhost:8080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"user@empresa.com","senha":"sua-senha"}'

# Response
{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "type": "Bearer"
}

Endpoints

Visao geral dos grupos de endpoints disponiveis na API.

2 endpoints

Auth

Autenticacao via JWT — login e troca de API key por token.

POST
5 endpoints

Clientes

CRUD de clientes vinculados a uma conta. Suporte a externalId para correlacao com seu sistema. Listagem com respostas paginadas.

GETPOSTPUTDELETE
6 endpoints

Cobranças

Criar cobranças PIX e cartão, consultar status, estornar. Suporte a externalId para rastreio. Listagem com respostas paginadas.

GETPOSTDELETE
4 endpoints

Conexões

Gerenciar conexões com provedores de pagamento (Asaas, MercadoPago). Listagem com respostas paginadas.

GETPOSTPUTDELETE
2 endpoints

Webhooks

Receber e verificar notificações dos provedores.

POST
4 endpoints

Contas

Gerenciar contas e configurações da operação.

GETPOSTPUT

Quick start

Autentique e crie sua primeira cobranca PIX em dois passos.

# 1. Autentique e obtenha um JWT
curl -s -X POST http://localhost:8080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"user@empresa.com","senha":"sua-senha"}' \
  | jq -r '.token'

# 2. Crie uma cobrança PIX
curl -X POST http://localhost:8080/api/v1/flashpays/asaas/pix \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "cus_abc123",
    "billingType": "PIX",
    "value": 49.90,
    "description": "Pedido #1042",
    "externalId": "ORDER-123"
  }'

# Respostas de listagem retornam envelope paginado:
# {
#   "data": [{ ... }, { ... }],
#   "pagination": {
#     "limit": 50, "offset": 0, "count": 12, "hasMore": false
#   }
# }

SDKs oficiais

Integre mais rapido com SDKs prontos para producao.

Pronto para integrar?

Crie sua conta, conecte um provedor e comece a processar pagamentos em minutos.