FrostPay API
A API do FrostPay permite integrar pagamentos via PIX, boleto e saques em sua plataforma de forma simples e segura.
🌐 Base URL: https://www.payfrost.com.br
📦 Formato: JSON
🔤 Charset: UTF-8
⏱️ Timeout: 30 segundos
🏦 Múltiplas Adquirentes: Suporte com fallback automático
Atualmente a API opera apenas em ambiente de produção. Todas as transações são reais e geram cobranças efetivas.
🔑 Chaves de Teste: Não há ambiente de homologação. Utilize valores baixos (ex: R$ 1,00) para testes.
Inclua suas credenciais nos headers HTTP de todas as requisições:
Onde obter: Painel → Chaves API
| Campo | Tipo | Descrição |
|---|---|---|
| amount | float | Valor da transação (mínimo R$ 1,00) obrigatório |
| customer[name] | string | Nome do cliente (máx 100 caracteres) obrigatório |
| customer[email] | string | E-mail do cliente obrigatório |
| customer[document] | string | CPF ou CNPJ (apenas números) opcional |
| customer[phone] | string | Telefone com DDD (apenas números) opcional |
| webhook_url | string | URL para notificação de pagamento opcional |
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | ID da transação retornado na criação obrigatório |
Emite um boleto e devolve a linha digitável. O valor vai em reais. A confirmação do pagamento usa o mesmo webhook da cobrança PIX, com payment_method igual a BOLETO.
| Campo | Tipo | Descrição |
|---|---|---|
| amount | float | Valor em reais. Mínimo R$ 1,00 obrigatório |
| customer[name] | string | Nome do pagador obrigatório |
| customer[email] | string | E-mail do pagador obrigatório |
| customer[document] | string | CPF ou CNPJ válido, com ou sem máscara obrigatório |
| customer[phone] | string | Telefone com DDD opcional |
| description | string | Descrição do boleto, até 200 caracteres opcional |
| webhook_url | string | URL da sua loja para receber a confirmação opcional |
Use o transaction_id devolvido na criação. A resposta traz o status e, enquanto o boleto existir, a linha digitável em barcode.
| Campo | Tipo | Descrição |
|---|---|---|
| amount | float | Valor do saque (mínimo R$ 1,00) obrigatório |
| pix_key | string | Chave PIX para recebimento obrigatório |
| pix_type | string | Tipo da chave: cpf, cnpj, email, phone, random opcional (padrão: cpf) |
| description | string | Descrição do saque opcional |
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | ID da transação de saque obrigatório |
| Campo | Tipo | Descrição |
|---|---|---|
| limit | int | Quantidade de registros (máx 100) opcional (padrão: 50) |
| offset | int | Páginação opcional (padrão: 0) |
| status | string | Filtrar por status opcional |
| type | string | Filtrar por tipo (DEPOSIT, WITHDRAW) opcional |
| date_from | date | Data inicial (YYYY-MM-DD) opcional |
| date_to | date | Data final (YYYY-MM-DD) opcional |
O FrostPay utiliza uma URL única para todas as adquirentes. O sistema identifica automaticamente qual adquirente está enviando o webhook baseado nos headers e no payload.
https://www.payfrost.com.br/api/v1/pix/webhook.php
| Adquirente | Headers de Identificação | Payload |
|---|---|---|
| Pluggou | X-Webhook-CodeUser-Agent: Pluggou-Webhook/1.0 |
event_type: "transaction" |
| BlueVision | Authorization: BasicX-Wishpag-Signature |
eventType (transação/saque) |
| Campo | Tipo | Descrição |
|---|---|---|
| event | string | Tipo do evento: transaction.paid, transaction.cancelled, transaction.refunded |
| transaction_id | string | ID da transação no FrostPay |
| amount | float | Valor bruto da transação |
| net_amount | float | Valor líquido (após taxas) |
| tax | float | Valor da taxa cobrada |
| status | string | Status atual: PENDING, PAID, CANCELLED, REVERSED, FAILED |
| status_text | string | Texto amigável do status |
| old_status | string | Status anterior da transação |
| old_status_text | string | Texto amigável do status anterior |
| confirmed_at | datetime | Data de confirmação do pagamento |
| created_at | datetime | Data de criação da transação |
| updated_at | datetime | Data da última atualização |
| customer_name | string | Nome do cliente |
| customer_email | string | E-mail do cliente |
| customer_document | string | CPF/CNPJ do cliente |
| customer_phone | string | Telefone do cliente |
| payment_method | string | Método de pagamento (PIX) |
| payment_provider | string | Adquirente que processou o pagamento |
Para configurar seu webhook, defina a URL no campo webhook_url ao criar a transação.
| Adquirente | URL para Configurar | Autenticação |
|---|---|---|
| Pluggou | https://www.payfrost.com.br/api/v1/pix/webhook.php |
X-Webhook-Code (painel Pluggou) |
| BlueVision | https://www.payfrost.com.br/api/v1/pix/webhook.php |
X-Wishpag-Signature + Basic Auth |
O FrostPay valida automaticamente a assinatura dos webhooks. Recomendamos:
Em caso de falha (timeout ou HTTP não 200), o sistema tenta reenviar:
O FrostPay suporta múltiplas adquirentes simultaneamente com fallback automático.
| Adquirente | Slug | Status | Taxa PIX |
|---|---|---|---|
| SELECT GESTAO E MARKETING | frostpay | Ativo | 6.99% |
| TRUSTED PAYMENT NETWORK | frostpay2 | Ativo | 6.99% |
| NATIONAL CORPORATE PARTNER | bluevision | Ativo | 6.00% |
| RAPDYN | rapdyn | Ativo | 6.00% |
| RAPDYN 2 | rapdyn2 | Ativo | 6.00% |
O SmartRouter gerencia o fallback entre adquirentes automaticamente:
| Prioridade | Adquirente | Slug |
|---|---|---|
| 1 | SELECT GESTAO E MARKETING | frostpay |
| 2 | TRUSTED PAYMENT NETWORK | frostpay2 |
| 3 | NATIONAL CORPORATE PARTNER | bluevision |
| 4 | RAPDYN | rapdyn |
| 5 | RAPDYN 2 | rapdyn2 |
| Código | Descrição |
|---|---|
MISSING_CREDENTIALS | Credenciais não fornecidas |
INVALID_CREDENTIALS | Credenciais inválidas |
IP_NOT_ALLOWED | IP não autorizado na whitelist |
INVALID_AMOUNT | Valor inválido (menor que R$ 1,00) |
MINIMUM_NET_AMOUNT | Valor líquido abaixo do mínimo permitido |
MISSING_CUSTOMER_DATA | Nome ou e-mail do cliente não informado |
INVALID_EMAIL | E-mail do cliente inválido |
TRANSACTION_FAILED | Falha ao processar transação |
QR_CODE_NOT_GENERATED | QR Code não gerado pela adquirente |
NO_ACQUIRENTE_AVAILABLE | Nenhuma adquirente disponível |
INSUFFICIENT_BALANCE | Saldo insuficiente |
WITHDRAWAL_FAILED | Falha ao processar saque |
Verifique se o Client-ID e Client-Secret estão corretos.
Adicione seu IP à whitelist no painel → Chaves API.
Verifique o saldo disponível via /api/v1/saque/balance
Confirme se o ID da transação está correto.
O valor após as taxas deve ser pelo menos R$ 0,10. Aumente o valor da transação.
Verifique se a URL está correta e acessível externamente. Certifique-se de que seu servidor responde com HTTP 200.