Saltar al contenido principal
La API de Tarifas devuelve, en una sola llamada, todas las tarifas efectivas de tu cuenta: pix, boleto, tarjeta (1x a 12x), retiro, reembolso y contracargo. Los valores ya vienen resueltos para la company autenticada — no necesitas calcular la precedencia ni saber de dónde proviene la tarifa.
Las tarifas se configuran por ámbito y se resuelven en el orden plataforma → company → global. Cuando no se ha configurado nada, el valor cae en 0. La respuesta entrega siempre el valor efectivo para tu cuenta, ya resuelto. Entiende el modelo en Valores · Tarifas.

​
Cómo interpretar una tarifa

Toda tarifa tiene dos componentes:

percentage

Porcentaje aplicado sobre el valor. 3.99 significa 3,99%.

fixed

Monto fijo en centavos (entero). 350 significa R$ 3,50.
La moneda sigue el estándar ISO 4217 (BRL, USD, …). La tarifa se resuelve por moneda; si no hay un override específico para la moneda solicitada, se aplica la tarifa configurada sin distinción de moneda.

​
Endpoints

MétodoRutaDescripción
GET/feesTabla de tarifas resuelta de la cuenta
Todas las solicitudes usan el header x-api-key. Ver Autenticación.

​
Consultar la tabla de tarifas

GET /fees
Devuelve pix, boleto, tarjeta de 1x a 12x, retiro, reembolso y contracargo (tarifa + multa) para la moneda indicada.

​
Parámetros de query

​
currency
string
Código de moneda en ISO 4217, exactamente 3 letras (ej: BRL). Se normaliza a mayúsculas automáticamente, por lo que brl y BRL funcionan igual.Opcional. Cuando se omite, usa la moneda predeterminada de tu company. Si la company tampoco tiene moneda predeterminada configurada, el fallback es BRL.

​
Ejemplo de solicitud

# Usando la moneda predeterminada de la company
curl https://api.sandbox.z2pay.com/fees \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

# Forzando una moneda específica
curl "https://api.sandbox.z2pay.com/fees?currency=BRL" \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

​
Respuesta

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 }
  }
}
Los números anteriores son ilustrativos. Las tarifas reales dependen de la configuración de tu cuenta — siempre lee los valores desde la respuesta de la API, nunca los escribas fijos en tu código.

​
Campos de la respuesta

​
currency
string
Moneda de las tarifas devueltas (ISO 4217). Refleja el currency del query, la moneda predeterminada de la company, o BRL como último fallback.
​
pix
object
Tarifa del método pix.
​
boleto
object
Tarifa del método boleto, con los mismos atributos percentage y fixed.
​
creditCard
array
Lista con una entrada por cuota, siempre de 1x hasta 12x (12 ítems).
​
withdrawal
object
Tarifa de retiro/payout (percentage + fixed).
​
refund
object
Tarifa de reembolso (percentage + fixed).
​
chargeback
object
Tarifas asociadas al contracargo.
El array creditCard siempre tiene 12 ítems, incluso si tu cuenta no opera con todas las cuotas. Para obtener la tarifa de una cuota específica, filtra por installments (ej: creditCard.find(c => c.installments === 3)).

​
Errores

Este endpoint requiere autenticación por API Key. Errores comunes: El formato de error está estandarizado en toda la API — detalles en Errores.

​
Ver también

Concepto de Tarifas

Cómo se modelan y resuelven las tarifas por precedencia.

Liquidación

Cómo las tarifas impactan el valor neto a recibir.

Split

División de valores entre receptores.

Autenticación

Cómo generar y enviar tu API Key.