Taxas da Conta

Esta seção explica como consultar as taxas configuradas para uma conta específica. Entender as taxas é essencial para calcular os custos das operações.

Visão Geral

Cada conta pode ter taxas personalizadas configuradas. As taxas podem ser de dois tipos:

• Taxa Fixa: Valor fixo em moeda (ex: R$ 0,25)
• Taxa Percentual: Percentual sobre o valor da transação (ex: 1,20%)

Endpoint

GET /account/{account_id}/fees

Retorna as taxas configuradas para uma conta específica.

URL Completa:

https://app.finexis.com.br/api/v1/gateway/account/{account_id}/fees

Headers:

Authorization: Bearer {token}

Parâmetros da URL:

• account_id (obrigatório): ID da conta

Exemplo de Requisição:

curl -X GET \
  'https://app.finexis.com.br/api/v1/gateway/account/5/fees' \
  -H 'Authorization: Bearer {seu_token}'

Resposta de Sucesso (200):

{
  "status": "success",
  "message": "Account fees retrieved successfully",
  "data": {
    "fees": [
      {
        "id": 1,
        "type": "fixed",
        "method": "deposit",
        "value": 0.25
      },
      {
        "id": 2,
        "type": "float",
        "method": "deposit",
        "value": 1.20
      }
    ]
  }
}

Campos das Taxas

Campo	Tipo	Descrição
id	integer	ID único da taxa
type	string	Tipo de taxa: fixed (fixa) ou float (percentual)
method	string	Método de cobrança (ex: deposit para depósitos)
value	number	Valor da taxa (fixo em moeda ou percentual)

Tipos de Taxa

• fixed: Taxa fixa em moeda. O valor é cobrado independentemente do valor da transação.

  • Exemplo: value: 0.25 = R$ 0,25 por transação

• float: Taxa percentual. O valor é calculado como percentual sobre o valor da transação.

  • Exemplo: value: 1.20 = 1,20% sobre o valor da transação

Métodos de Cobrança

• deposit: Taxa aplicada em depósitos/recebimentos

Exemplo de Cálculo

Para uma transação de R$ 100,00 com as taxas do exemplo acima:

1. Taxa Fixa: R$ 0,25
2. Taxa Percentual: R$ 100,00 × 1,20% = R$ 1,20
3. Total de Taxas: R$ 0,25 + R$ 1,20 = R$ 1,45

Casos de Uso

Este endpoint é útil para:

• Calcular os custos antes de realizar uma transação
• Exibir as taxas para o usuário final
• Implementar lógica de cálculo de taxas na sua aplicação
• Verificar se há taxas configuradas antes de processar pagamentos

Próximos Passos

• Consulte as Informações da Conta para ver o saldo disponível
• Comece a criar Cobranças PIX
• Realize Transferências PIX