Skip to main content

Base URL

Todas as requisições da API devem ser feitas para:

Autenticação

Todas as requisições requerem autenticação via headers customizados:

Como autenticar

Veja o guia completo de autenticação

Endpoints Disponíveis

💰 Gateway PIX

Endpoints para criar e gerenciar cobranças e pagamentos PIX.

Gerar QR Code PIX

POST /api/v1/gateway/request-qrcodeCria uma cobrança PIX e gera o QR Code para pagamento

Realizar Pagamento PIX

POST /api/v1/gateway/pix-paymentEnvia um pagamento PIX para qualquer chave

💼 Wallet (Carteira)

Endpoints para gerenciamento de saldo e transações.

Consultar Saldo

GET /api/v1/wallet/balanceConsulta o saldo disponível na carteira

Histórico de Transações

GET /api/v1/wallet/transactionsLista todas as transações realizadas

🔔 Webhooks

Sistema de notificações em tempo real.

Webhooks

Configure URLs para receber notificações automáticas sobre mudanças de status em transações

Estrutura de Resposta

Respostas de Sucesso

Todas as respostas bem-sucedidas retornam status HTTP 2xx:

Respostas de Erro

Erros retornam status HTTP 4xx ou 5xx com a seguinte estrutura:

Códigos de Status Comuns

OK
Requisição processada com sucesso
Created
Recurso criado com sucesso
Bad Request
Parâmetros inválidos na requisição
Unauthorized
Credenciais de autenticação inválidas ou ausentes
Not Found
Recurso não encontrado
Internal Server Error
Erro interno do servidor

Rate Limiting

A API StylePay implementa rate limiting para garantir estabilidade:
Limite padrão: 100 requisições por minuto por Client ID
Quando o limite é excedido, você receberá uma resposta 429 Too Many Requests:

Headers de Rate Limit

Todas as respostas incluem headers informativos:

Tipos de Dados

Valores Monetários

Todos os valores monetários são enviados e recebidos como números decimais em reais (BRL):
Sempre use ponto (.) como separador decimal, nunca vírgula (,)

Datas

Todas as datas seguem o formato ISO 8601 com timezone UTC:

Documentos

CPF e CNPJ devem ser enviados apenas com números, sem pontos, traços ou barras:

Chaves PIX

Tipos de chave PIX aceitos:

Idempotência

Para operações críticas como criação de pagamentos, use o campo external_id para garantir idempotência:
Se você enviar a mesma requisição com o mesmo external_id múltiplas vezes, apenas uma transação será criada.

Ambientes

Produção

Este é o ambiente de produção. Todas as transações movimentam dinheiro real.

Bibliotecas e SDKs

Estamos trabalhando em SDKs oficiais. Por enquanto, você pode integrar usando bibliotecas HTTP padrão:

Webhooks

A API StylePay envia notificações automáticas para sua aplicação quando eventos importantes ocorrem:

Cash-in

Notificações de recebimentos

Cash-out

Notificações de pagamentos

Refunds

Notificações de estornos

Configurar Webhooks

Veja como configurar e processar webhooks

Exemplos Práticos

Fluxo Completo: Receber Pagamento

1

Criar QR Code

Gera QR Code para o cliente pagar
2

Cliente Paga

O cliente escaneia o QR Code e confirma o pagamento no app do banco
3

Receber Webhook

Você recebe notificação automática do pagamento
4

Confirmar Saldo

Consulta o saldo atualizado na carteira

Fluxo Completo: Enviar Pagamento

1

Verificar Saldo

Confirma que tem saldo suficiente
2

Enviar Pagamento

Envia PIX para a chave do destinatário
3

Receber Confirmação

Webhook confirma que pagamento foi realizado

Suporte

Documentação

Guias e tutoriais completos

WhatsApp

+55 11 9999-9999

Próximos Passos

Gerar QR Code PIX

Comece criando sua primeira cobrança

Realizar Pagamento

Aprenda a enviar pagamentos PIX

Consultar Saldo

Gerencie o saldo da sua carteira

Configurar Webhooks

Receba notificações em tempo real