Documentação da API Flowpag

Guia completo para integração com nosso gateway de pagamentos PIX

v1.0
Navegação
IntroduçãoAutenticaçãoCash-in PIXCash-out PIXCallbacksSchemasCódigos de Resposta
Introdução
Bem-vindo à documentação da API Flowpag - processamento PIX especializado

A API Flowpag é especializada em processamento PIX para plataformas online, rifas, iGaming, Open Banking e outros segmentos digitais. Nossa API RESTful oferece endpoints seguros para cash-in, cash-out e callbacks em tempo real.

PIX Especializado

Foco exclusivo em PIX

API Simples

Integração rápida

Callbacks

Notificações instantâneas

Autenticação
POST /auth/token - Obter token de acesso
POST
/auth/token

Sem parâmetros de URL

Request Body (application/json):

{
  "clientId": "string",
  "clientSecret": "string"
}

Resposta 200 OK: Retorna token JWT para autenticação nas demais requisições

Cash-in PIX
POST /cash_in/pix - Criar transação de entrada PIX
POST
/cash_in/pix

Sem parâmetros de URL

Request Body (application/json):

{
  "amount": 0,
  "payer": {
    "name": "string",
    "tax_id": "string", 
    "email": "string",
    "phone": "string"
  }
}

Exemplo prático:

amount: Valor em centavos (ex: 10000 = R$ 100,00)
payer: Dados completos do pagador para identificação

Resposta 200 OK: Retorna QR Code PIX, chave PIX e dados da transação

Cash-out PIX
POST /cash_out/pix - Realizar saque via PIX
POST
/cash_out/pix

Sem parâmetros de URL

Request Body (application/json):

{
  "amount": 0,
  "receiver": {
    "name": "string",
    "tax_id": "string",
    "email": "string", 
    "phone": "string"
  },
  "pix": {
    "pixType": "string",
    "pixKey": "string"
  }
}

Tipos de chave PIX:

email: email@exemplo.com
cpf: 12345678901
phone: +5511999999999
random: chave aleatória

Resposta 200 OK: Confirmação do saque processado

Callbacks
POST /callback/xgate - Receba notificações de status

Configure sua URL de callback no dashboard para receber notificações automáticas sobre mudanças de status nas transações PIX.

POST
/callback/xgate

Endpoint que sua aplicação receberá

Estrutura do callback recebido:

{
  "id": "string",
  "customerId": "string", 
  "status": "string",
  "name": "string",
  "type": "string",
  "amount": 0,
  "operation": "string"
}

Status possíveis:

pending
completed
failed
cancelled
Schemas de Dados
Estruturas de dados utilizadas na API Flowpag
CashinCommand {
  amount: number,     // Valor em centavos
  payer: PayerDto     // Dados do pagador
}
Códigos de Resposta
Códigos HTTP e suas respectivas descrições
200
OK
Requisição processada com sucesso
201
Created
Transação criada com sucesso
400
Bad Request
Dados inválidos na requisição
401
Unauthorized
Token inválido ou ausente
404
Not Found
Recurso não encontrado
500
Internal Server Error
Erro interno do servidor

Pronto para integrar?

Crie sua conta e comece a processar PIX em minutos