Pular para o conteúdo principal
A API de Taxas devolve, em uma única chamada, todas as taxas efetivas da sua conta: pix, boleto, cartão (1x a 12x), saque, reembolso e chargeback. Os valores já vêm resolvidos para a company autenticada — você não precisa calcular precedência nem saber de onde a taxa veio.
As taxas são configuradas por escopo e resolvidas na ordem plataforma → company → global. Quando nada foi configurado, o valor cai em 0. A resposta entrega sempre o valor efetivo para a sua conta, já resolvido. Entenda o modelo em Valores · Taxas.

Como ler uma taxa

Toda taxa tem dois componentes:

percentage

Percentual aplicado sobre o valor. 3.99 significa 3,99%.

fixed

Parcela fixa em centavos (inteiro). 350 significa R$ 3,50.
A moeda segue o padrão ISO 4217 (BRL, USD, …). A taxa é resolvida por moeda; sem override específico para a moeda pedida, cai na taxa moeda-agnóstica configurada.

Endpoints

MétodoRotaDescrição
GET/feesTabela de taxas resolvida da conta
Todas as requisições usam o header x-api-key. Veja Autenticação.

Consultar a tabela de taxas

GET /fees
Retorna pix, boleto, cartão de 1x a 12x, saque, reembolso e chargeback (taxa + multa) para a moeda informada.

Parâmetros de query

currency
string
Código da moeda em ISO 4217, exatamente 3 letras (ex: BRL). É normalizado para maiúsculas automaticamente, então brl e BRL funcionam igual.Opcional. Quando omitido, usa a moeda padrão da sua company. Se a company também não tiver moeda padrão configurada, o fallback é BRL.

Exemplo de requisição

# Usando a moeda padrão da company
curl https://api.sandbox.z2pay.com/fees \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"
# Forçando uma moeda específica
curl "https://api.sandbox.z2pay.com/fees?currency=BRL" \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

Resposta

200 OK
{
  "currency": "BRL",
  "pix": { "percentage": 0.99, "fixed": 0 },
  "boleto": { "percentage": 0, "fixed": 350 },
  "creditCard": [
    { "installments": 1, "percentage": 3.99, "fixed": 0 },
    { "installments": 2, "percentage": 4.49, "fixed": 0 },
    { "installments": 3, "percentage": 4.99, "fixed": 0 },
    { "installments": 4, "percentage": 5.29, "fixed": 0 },
    { "installments": 5, "percentage": 5.59, "fixed": 0 },
    { "installments": 6, "percentage": 5.89, "fixed": 0 },
    { "installments": 7, "percentage": 6.09, "fixed": 0 },
    { "installments": 8, "percentage": 6.29, "fixed": 0 },
    { "installments": 9, "percentage": 6.49, "fixed": 0 },
    { "installments": 10, "percentage": 6.69, "fixed": 0 },
    { "installments": 11, "percentage": 6.89, "fixed": 0 },
    { "installments": 12, "percentage": 6.99, "fixed": 0 }
  ],
  "withdrawal": { "percentage": 0, "fixed": 367 },
  "refund": { "percentage": 0, "fixed": 0 },
  "chargeback": {
    "fee": { "percentage": 0, "fixed": 0 },
    "penalty": { "percentage": 0, "fixed": 0 }
  }
}
Os números acima são ilustrativos. As taxas reais dependem da configuração da sua conta — sempre leia da resposta da API, nunca chumbe valores no seu código.

Campos da resposta

currency
string
Moeda das taxas retornadas (ISO 4217). Reflete o currency da query, a moeda padrão da company, ou BRL como último fallback.
pix
object
Taxa do método pix.
boleto
object
Taxa do método boleto, com os mesmos atributos percentage e fixed.
creditCard
array
Lista com uma entrada por parcela, sempre de 1x até 12x (12 itens).
withdrawal
object
Taxa de saque/payout (percentage + fixed).
refund
object
Taxa de reembolso (percentage + fixed).
chargeback
object
Taxas associadas a chargeback.
O array creditCard sempre tem 12 itens, mesmo que sua conta não opere com todas as parcelas. Para pegar a taxa de uma parcela específica, filtre por installments (ex: creditCard.find(c => c.installments === 3)).

Erros

Esse endpoint requer autenticação por API Key. Erros comuns: O formato de erro é padronizado em toda a API — detalhes em Erros.

Veja também

Conceito de Taxas

Como as taxas são modeladas e resolvidas por precedência.

Liquidação

Como as taxas impactam o valor líquido a receber.

Split

Divisão de valores entre recebedores.

Autenticação

Como gerar e enviar sua API Key.