RaposaPay Gateway

API Documentation

Guia técnico para integrar autenticação, Pix e saques com exemplos em curl e resposta JSON.

Base URL https://api.raposapay.com

KEY Autenticação — Chave Secreta

Painel > Integração > Gerar chave

Todas as requisições são autenticadas com a chave secreta gerada na aba Integração do painel. Não é necessário enviar username, user_id ou nenhum outro identificador.

Envie a chave secreta em todo request à API.

A chave secreta deve ficar somente no seu backend; nunca exponha no frontend ou em código público.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração (prefixo sk_). Mantenha apenas no backend.

Exemplo de autenticação

curl -sS "https://api.raposapay.com/api/public/auth/validate" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Boas práticas

{
  "guarde_em": "backend do seu sistema",
  "nao_exponha_em": "frontend público ou repositórios",
  "recrie_quando": "precisar invalidar a chave atual"
}

GET Validar Chave

/api/public/auth/validate

Valida a chave secreta e retorna os dados da conta associada.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração.

Example Request

curl -sS "https://api.raposapay.com/api/public/auth/validate" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "authenticated": true,
  "account": {
    "user_id": "joaosilva",
    "username": "joaosilva",
    "status": true,
    "saldo": 1250.75,
    "min_deposit": 5.0,
    "max_deposit": 50000.0,
    "min_withdraw": 10.0,
    "max_withdraw": 1000.0,
    "credential_created_at": "17/04/2026 14:22:10"
  }
}

GET Dados Completos da Conta

/api/public/account

Retorna o payload completo da conta na API RaposaPay (saldo, limites, taxas, provider ativo, depósitos e saques).

Endpoint próprio da RaposaPay: o contrato de resposta permanece estável mesmo ao trocar o provider.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração.

Example Request

curl -sS "https://api.raposapay.com/api/public/account" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "account": {
    "user_id": "1224983052",
    "saldo": 1250.75,
    "status": true,
    "min_deposit": 5.0,
    "max_deposit": 50000.0,
    "min_withdraw": 10.0,
    "max_withdraw": 1000.0,
    "active_provider": "evopay-v2",
    "deposits": [...],
    "withdraws": [...]
  },
  "summary": {
    "total_deposits": 24,
    "total_withdraws": 7,
    "active_provider": "evopay-v2"
  }
}

GET Histórico de Depósitos

/api/public/account/deposits

Lista os depósitos da conta autenticada em formato padronizado da RaposaPay.

Query Parameters

Campo
Tipo
Req.
Descrição
limit
number
não
Quantidade máxima de itens (padrão 50, máximo 500).
status
string
não
Filtro por status (ex: PAID, PENDING). Aceita CSV.

Example Request

curl -sS "https://api.raposapay.com/api/public/account/deposits?limit=20&status=PAID" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "count": 2,
  "total_available": 2,
  "limit": 20,
  "items": [
    {
      "id": "cmm1ikzba0kcge7n9fqa0kj1e",
      "valor": 25.5,
      "taxa": 0.9,
      "liquido": 24.6,
      "status": "PAID",
      "date": "12/03/2026 18:28:12",
      "source": "api"
    }
  ]
}

GET Histórico de Saques

/api/public/account/withdraws

Lista saques da conta autenticada (Pix e/ou Crypto), sem depender do formato do provider.

Query Parameters

Campo
Tipo
Req.
Descrição
limit
number
não
Quantidade máxima de itens (padrão 50, máximo 500).
status
string
não
Filtro por status (ex: COMPLETED, PROCESSING). Aceita CSV.
method
string
não
Filtro por método (ex: pix, crypto). Aceita CSV.

Example Request

curl -sS "https://api.raposapay.com/api/public/account/withdraws?limit=20&method=pix" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "count": 1,
  "total_available": 1,
  "items": [
    {
      "id": "2dd6520b-77db-4ca8-88ce-f7e1ddbe2d72",
      "method": "pix",
      "valor": 100.0,
      "valor_bruto": 103.0,
      "status": "COMPLETED",
      "date": "13/03/2026 11:50:32"
    }
  ]
}

GET Taxas e Limites

/api/public/account/fees

Retorna taxas do usuário, limites operacionais e custos do provider ativo no momento.

A resposta mantém o mesmo formato mesmo se você trocar de provider.

Example Request

curl -sS "https://api.raposapay.com/api/public/account/fees" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "fees": {
    "deposit_percent": 0.05,
    "deposit_fixed": 0.40,
    "withdraw_percent": 0.03,
    "withdraw_fixed": 3.0
  },
  "limits": {
    "min_deposit": 5.0,
    "max_deposit": 50000.0,
    "min_withdraw": 10.0,
    "max_withdraw": 1000.0
  },
  "provider": {
    "active_provider": "evopay-v2",
    "active_provider_name": "EvoPay v2"
  }
}

POST Criar Transação Pix

/api/public/pix/create

Cria uma cobrança Pix e retorna tx_id, copia e cola e QR Code.

Use o tx_id para consultar o pagamento no endpoint de status.

generatedName não aceita acentos, números ou símbolos. generatedDocument aceita CPF com ou sem máscara.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração.

Body Parameters

Campo
Tipo
Req.
Descrição
amount
number
sim
Valor bruto do depósito.
generatedName
string
sim
Nome do pagador, sem acentos, números ou símbolos.
generatedEmail
string
sim
E-mail do pagador em formato válido.
generatedDocument
string
sim
CPF do pagador. Aceita com ou sem pontuação.
callbackUrl
string
não
URL pública para notificações de mudança de status.
callbackToken
string
não
Segredo para assinar o webhook de saída.
externalReference
string
não
Referência externa do pedido no seu sistema.

Example Request

curl -sS -X POST "https://api.raposapay.com/api/public/pix/create" \
  -H "Content-Type: application/json" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "amount": 25.50,
    "generatedName": "Joao Silva",
    "generatedEmail": "joao@email.com",
    "generatedDocument": "09115751031",
    "callbackUrl": "https://cliente.com/webhooks/pix",
    "externalReference": "pedido-12345"
  }'

Example Response

{
  "ok": true,
  "tx_id": "cmm1ikzba0kcge7n9fqa0kj1e",
  "amount": 25.5,
  "qr_code_text": "000201...",
  "qr_code_base64": "iVBORw0KGgo...",
  "expires_in_seconds": 300,
  "status": "PENDING",
  "callback_configured": true,
  "external_reference": "pedido-12345",
  "active_provider": "evopay-v2"
}

GET Consultar Status Pix

/api/public/pix/status/{tx_id}

Consulta o status atual de uma cobrança Pix.

Path Parameters

Campo
Tipo
Req.
Descrição
tx_id
string
sim
ID da transação criada no endpoint de criação Pix.

Example Request

curl -sS "https://api.raposapay.com/api/public/pix/status/cmm1ikzba0kcge7n9fqa0kj1e" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx"

Example Response

{
  "ok": true,
  "tx_id": "cmm1ikzba0kcge7n9fqa0kj1e",
  "status": "PAID",
  "paid": true,
  "amount": 25.5,
  "date": "12/03/2026 18:28:12"
}

POST Efetuar Saque Pix

/api/public/withdraw/create

Solicita saque via Pix com desconto de taxa no valor bruto.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração.

Body Parameters

Campo
Tipo
Req.
Descrição
method
string
sim
Use "pix".
amount
number
sim
Valor líquido solicitado.
pix_type
string
sim
cpf, email ou phone.
pix_key
string
sim
Chave Pix de destino.

Example Request

curl -sS -X POST "https://api.raposapay.com/api/public/withdraw/create" \
  -H "Content-Type: application/json" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "method": "pix",
    "amount": 100,
    "pix_type": "cpf",
    "pix_key": "12345678901"
  }'

Example Response

{
  "ok": true,
  "operation_id": "2dd6520b-77db-4ca8-88ce-f7e1ddbe2d72",
  "withdraw": {
    "id": "w_9f95a3f6",
    "method": "pix",
    "status": "PROCESSING",
    "valor": 100.0,
    "valor_bruto": 103.0,
    "taxa": 3.0,
    "pix_type": "cpf",
    "pix_key": "12345678901"
  },
  "account": {
    "user_id": "joaosilva",
    "username": "joaosilva",
    "saldo": 897.0
  }
}

POST Efetuar Saque USDT

/api/public/withdraw/create

Solicita saque em USDT na rede selecionada.

Headers

Header
Tipo
Req.
Descrição
X-API-Secret-Key
string
sim
Chave secreta da integração.

Body Parameters

Campo
Tipo
Req.
Descrição
method
string
sim
Use "crypto".
amount
number
sim
Valor líquido em BRL.
asset
string
sim
Ativo (ex: USDT).
network
string
sim
Rede (ex: BEP20).
wallet_address
string
sim
Carteira de destino.

Example Request

curl -sS -X POST "https://api.raposapay.com/api/public/withdraw/create" \
  -H "Content-Type: application/json" \
  -H "X-API-Secret-Key: sk_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "method": "crypto",
    "amount": 120,
    "asset": "USDT",
    "network": "BEP20",
    "wallet_address": "0x1234567890abcdef1234567890abcdef12345678"
  }'

Example Response

{
  "ok": true,
  "operation_id": "6f4f7f0d-8a5a-41ca-b9f7-4f6f5f26f9f0",
  "withdraw": {
    "method": "crypto",
    "status": "PROCESSING",
    "valor": 120.0,
    "valor_bruto": 124.0,
    "taxa": 4.0,
    "asset": "USDT",
    "network": "BEP20",
    "wallet_address": "0x1234...5678"
  },
  "account": {
    "user_id": "joaosilva",
    "username": "joaosilva",
    "saldo": 876.0
  }
}