Skip to main content
GET
Esta rota mostra as taxas configuradas para uma subconta (transacionais e de antecipação) junto com a razão social e o CNPJ dela. São as taxas efetivas: na cobrança, a API usa só as taxas da própria conta que cobra, sem consultar a conta master. Serve para conferir o que cada vendedor paga, montar simuladores de taxa no seu sistema e conciliar valores líquidos.

Quando usar

Antes de chamar

  • Para consultar como conta master, o módulo Connect precisa estar habilitado pela Finvia na sua conta (sem isso, 403), e a subconta precisa estar ligada a ela.
  • Tenha o id da subconta, devolvido em Criar subconta ou em Listar subcontas.

Autenticação

Use a chave secreta (sk_) em Basic, como no resto da API. Veja Credenciais e ambientes.

Quem está autenticado muda a resposta

O resultado depende do id informado e também de qual conta faz a chamada.

Parâmetros de caminho

string
required
Id (KSUID) da subconta. Obrigatório quando a chamada é feita pela conta master; ignorado quando é feita pela subconta. Ex.: 2v2TGGb4NHTQWCiMmnelz2WVOZP.

Respostas

object
Dados cadastrais da subconta.
object[]
Taxas da subconta, em lista plana, ordenada por tipo, método, moeda e bandeira. Array vazio significa subconta sem taxas configuradas: as cobranças dela são recusadas até a configuração.
fees não traz a reserva financeira nem a taxa de saque da subconta.

De onde vêm as taxas

Na criação, a subconta recebe uma cópia das taxas vigentes da conta master. Depois disso, as taxas da subconta são independentes: alterar as taxas da master não muda as das subcontas já criadas. A Finvia pode replicar uma alteração para as subcontas por operação interna. Se a subconta chegar à pré-aprovação sem nenhuma taxa (por exemplo, porque a master não tinha taxas quando ela foi criada), ela recebe uma cópia das taxas padrão da plataforma naquele momento.

Como chegar à taxa efetiva

As taxas vêm como estão cadastradas. A rota não escolhe a linha da bandeira nem a parcela por você. Para a taxa transacional (tx_spread), siga os passos abaixo.
1

Filtre pelo tipo, método e moeda

Ex.: feeType tx_spread, paymentMethod credit_card, currencyCode BRL.
2

Procure a bandeira do cartão

Se existir uma linha com a brand da venda (ex.: visa), use essa linha.
3

Caia para a taxa padrão

Se não houver linha da bandeira, use a linha com brand null.
4

Escolha o percentual da parcela

O percentual é definition.percentages[parcelas - 1]. No exemplo, 3x usa o índice 2: 3,99%. A taxa definition.fixed é cobrada por transação.
Para a antecipação (anticipation), só percentages[0] é usado. É uma taxa mensal, multiplicada pelo número de meses até o vencimento da parcela (mínimo de 1 mês), e só incide quando o recebível é antecipado. Exemplo com percentages[0] igual a 1.99: uma parcela que vence em 3 meses, se antecipada, paga 1,99% × 3 = 5,97% sobre o valor dela.
fees vazio, ou sem linha para o método e a moeda da cobrança, significa que a subconta não tem taxa configurada para essa combinação. As cobranças dessa combinação são recusadas com 422 Fees not configured. Não interprete a lista vazia como taxa zero e não use as taxas da master no lugar: fale com o suporte da Finvia para configurar.
Para o negócio: a Finvia aplica o percentual de split sobre o valor líquido, depois das taxas dela. Se a sua plataforma cobra uma comissão sobre o valor bruto da venda, use as taxas desta rota para chegar ao percentual certo. O passo a passo está em Cálculo de split.

Erros comuns

Veja também

Taxas no Connect

Como as taxas das subcontas funcionam.

Cálculo de split

Percentual de split considerando as taxas.

Consultar subconta

Dados e status da subconta.

Visão geral do Connect

Conta master e subcontas.