Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usealpa.com/llms.txt

Use this file to discover all available pages before exploring further.

Consultar taxas

GET /api/user/fees
Autenticação: Bearer Token (JWT) Retorna as taxas configuradas para a conta do merchant — taxa fixa (em centavos) + percentual variável + percentual de reserva, para cada método de pagamento.

Exemplo

curl --request GET \
  --url https://alpa-sistema-api.onrender.com/api/user/fees \
  --header 'Authorization: Bearer SEU_JWT_TOKEN'

Resposta (200 OK)

{
  "success": true,
  "data": {
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "pix": {
      "fixed": "2,99",
      "variable": "3,99",
      "reserve": "0,50",
      "fixedCents": 299,
      "variablePercent": 3.99,
      "reservePercent": 0.50
    },
    "boleto": {
      "fixed": "4,38",
      "variable": "4,50",
      "reserve": "0,50",
      "fixedCents": 438,
      "variablePercent": 4.50,
      "reservePercent": 0.50
    },
    "card": {
      "fixed": "3,99",
      "variable": "5,99",
      "reserve": "0,50",
      "fixedCents": 399,
      "variablePercent": 5.99,
      "reservePercent": 0.50,
      "installments": {
        "2": "14,99",
        "3": "16,49",
        "12": "29,99"
      }
    },
    "isDefault": true
  },
  "message": "Taxas padrão retornadas - usuário não possui taxas configuradas"
}
CampoDescrição
fixed / fixedCentsTaxa fixa por transação (formato BR / em centavos)
variable / variablePercentTaxa percentual sobre o valor bruto
reserve / reservePercentPercentual de reserva retido por período
installmentsTaxas por número de parcelas (1×–12×) — apenas cartão
isDefaulttrue quando a conta ainda não tem taxas customizadas
A taxa total de uma transação é: taxa_fixa + (valor × variablePercent / 100) + (valor × reservePercent / 100). O netAmountCents creditado na carteira é o valor bruto menos essa soma.

Consultar saldo

Verifique o saldo disponível e a liberar.