Skip to main content

​
Visão geral

A API de Taxas permite que você consulte as taxas configuradas para sua conta, calcule o impacto de taxas em transações específicas e visualize estatísticas de custos.

​
Endpoints Disponíveis

Todos os endpoints requerem autenticação via API Key.

​
1. Consultar minhas taxas

Retorna a configuração atual de taxas (PIX, Cartão, Boleto, etc). GET /api/user/fees

​
Resposta de Sucesso (200 OK)

{
  "pix": {
    "percentage": 0.99,
    "fixedCents": 0
  },
  "card": {
    "percentage": 3.49,
    "fixedCents": 50,
    "installmentIntervals": [
      { "from": 2, "to": 6, "additionalPercentage": 1.5 },
      { "from": 7, "to": 12, "additionalPercentage": 2.5 }
    ]
  },
  "withdraw": {
    "fixedCents": 350
  }
}

​
2. Simular cálculo de taxas

Calcula quanto será descontado de um determinado valor bruto. GET /api/user/fees/calculate

​
Parâmetros de Query

ParâmetroTipoDescrição
amountCentsnumberValor base da transação.
methodstringpix, card ou boleto.
installmentsnumberQuantidade de parcelas (para card).

​
3. Estatísticas de Taxas

Gera um resumo dos custos operacionais em um período. GET /api/user/fees/statistics

​
Resposta de Sucesso (200 OK)

{
  "period": "last_30_days",
  "totalFeesCents": 12500,
  "netAmountCents": 487500,
  "averageFeePercentage": 2.5
}

​
Validação de Configuração

GET /api/user/fees/validate Este endpoint verifica se sua conta possui todas as configurações de taxas necessárias para operar. Se retornar valid: false, entre em contato com o suporte para regularizar sua conta.