Pular para o conteúdo principal
GET
Get store fees

💰 Obter Taxas do Gateway

GET /stores/{storeId}/fees Retorna as formas de pagamento e as taxas das gateways ativas da loja.
Importante: as taxas retornadas aqui são as definidas pelo lojista no dashboard (seção “Taxas por método” de cada gateway), ou seja, o percentual/valor fixo que ele decide repassar ao cliente no checkout. Elas não representam o custo que a gateway cobra do lojista — esse custo é interno e fica apenas no frontend do dashboard (tabela GATEWAY_FEES), usado para calcular o valor líquido que o lojista recebe.

🔐 Autenticação

  • Rota pública.
  • A loja vinculada precisa ter plano ativo.

🧾 Parâmetros de rota


✅ Exemplo de requisição


📦 Resposta de sucesso (200)

  • gateways[] → todas as gateways ativas do dono da loja (type entre MERCADOPAGO, ASAAS, EFI_BANK e STRIPE, métodos disponíveis methods[], maxInstallments, installmentFees[], fees por método com percent + fixed, além de publicKey opcional/nullable quando configurada e payeeCode opcional/nullable para EFI_BANK quando configurado).
  • fees (top-level) → taxas do primeiro gateway ativo, mantido para compatibilidade com consumidores antigos.
  • Os valores de fees (ex.: Mercado Pago card 4,99%, Asaas pix R$ 1,99 / card 2,99% + R$ 0,49) são configurados pelo lojista e podem variar de loja para loja — não são valores fixos garantidos nem o custo real da gateway.
Quando a loja não possui um gateway ativo (ou não tem credenciais configuradas), as taxas retornam vazias:

⚠️ Possíveis erros

  • 403 NO_ACTIVE_SUBSCRIPTION → a loja vinculada está sem plano ativo
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível

📝 Observações

  • gateways[] reflete todas as gateways marcadas como ativas do dono da loja (MERCADOPAGO, ASAAS, EFI_BANK, STRIPE).
  • publicKey é retornado no objeto da gateway quando presente nas credenciais configuradas (ex.: Mercado Pago ou Stripe); para EFI_BANK, payeeCode também é retornado quando configurado.
  • methods[] vem de credentials.paymentMethods de cada gateway (fallback: padrão do tipo — MERCADOPAGO: pix/card/boleto/saldo; ASAAS, EFI_BANK e STRIPE: pix/card/boleto).
  • maxInstallments → número máximo de parcelas no cartão configurado pelo lojista (padrão 1, máximo 12).
  • installmentFees → lista de faixas de parcelas configuradas pelo lojista, com taxa própria por intervalo { min, max, percent, fixed } (máximo 12 faixas, sem sobreposição). Quando a faixa do installmentCount existe, checkout e cobrança a usam no lugar da taxa plana fees.card — garantindo que o valor exibido ao cliente bate com o cobrado.
  • Taxas são lidas das credenciais descriptografadas (AES-256-GCM) do gateway.
  • O checkout público usa esta rota para exibir as formas de pagamento reais da loja (ex.: Mercado Pago + Asaas), as parcelas disponíveis (maxInstallments) e calcular o repasse de taxa por método/faixa.

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50

Resposta

Active gateways and store fees.

fees
object
obrigatório
gateways
object[]
obrigatório