Introdução

Referência técnica para a API de Pagamentos PIX v2.0.0.

URL Base
https://api.flippei.com/api/v1
Formato
JSON
Autenticação
API Key e Secret

Autenticação

Requisições requerem headers de autenticação.

Headers

Content-Type: application/json
X-API-Key: [API_KEY]
X-API-Secret: [API_SECRET]

Gerencie credenciais de forma segura.

Endpoints

POST /api/v1/pix/create

Cria transação PIX.

Headers

Content-Type: application/json
X-API-Key: [API_KEY]
X-API-Secret: [API_SECRET]
X-Idempotency-Key: [CHAVE]

Body

{
  "amount": 12.00,
  "description": "Cobrança de Serviço",
  "customer": {
    "name": "Fernando Gomes",
    "email": "contato@empresa.com",
    "phone": "11981391092",
    "document": {
      "number": "33587638896",
      "type": "CPF"
    }
  },
  "items": [
    {
      "title": "Produto/Serviço",
      "unitPrice": 100.00,
      "quantity": 1
    }
  ],
  "postbackUrl": "https://seu-endpoint-webhook.com/notificacoes"
}

Resposta

{
  "status": true,
  "paymentData": {
    "transactionId": "9fc4c474be423d852f3f6acdca919a",
    "status": "PENDING",
    "copiaecola": "00020126820014br.gov.bcb.pix...",
    "qrcode": "data:image/png;base64,iVBOR...",
    "amount": 12.00
  }
}

GET /api/v1/transactions/{transactionId}/status

Consulta status de transação.

Headers

X-API-Key: [API_KEY]
X-API-Secret: [API_SECRET]

Resposta

{
  "success": true,
  "data": {
    "transactionId": "9fc4c474be423d852f3f6acdca919a",
    "status": "PENDING",
    "amount": 12.00,
    "netAmount": 11.50,
    "fee": 0.50,
    "description": "Cobrança de Serviço",
    "createdAt": "2024-01-01T10:00:00Z",
    "updatedAt": "2024-01-01T10:00:00Z"
  }
}

GET /api/v1/account/balance

Consulta saldo da conta.

Headers

X-API-Key: [API_KEY]
X-API-Secret: [API_SECRET]

Resposta

{
  "success": true,
  "data": {
    "saldo_disponivel": 1000.00,
    "limite_diario": 10000.00,
    "limite_mensal": 100000.00,
    "status_conta": "ativa"
  }
}

Webhooks

Notificações assíncronas para eventos.

POST [URL Configurado]

Payload

{
  "transaction_id": "1234567890",
  "payment_id": 12345,
  "status": "COMPLETED",
  "amount": 12.00,
  "fee": 0.50,
  "net_amount": 11.50,
  "payment_method": "pix",
  "description": "Cobrança de Serviço",
  "customer": {
    "name": "Fernando Gomes",
    "email": "contato@empresa.com"
  },
  "metadata": {}
}

Valide assinatura via HMAC.

Códigos de Status e Erros

Status de Transação

Status Descrição
PENDINGAguardando confirmação.
PROCESSINGEm processamento.
COMPLETEDConcluída.
REJECTEDRejeitada.
CANCELLEDCancelada.

Erros HTTP

Código Descrição Ação
400Dados inválidos.Verifique entrada.
401Não autorizado.Atualize credenciais.
404Não encontrado.Confira ID.
422Validação falhou.Analise erros.
500Erro interno.Contate suporte.

Melhores Práticas

  • Use SDKs oficiais.
  • Monitore latências.
  • Cumpra regulamentações.
  • Teste em sandbox.
  • Integre antifraude.