Esta página es conceptual y contiene la referencia del endpoint de consulta. Para entender cómo la tarifa de plataforma interviene en la división de valores, consulta Split.
Cómo se compone la tarifa
Toda tarifa se describe con dos campos:Porcentaje de la tarifa. Ejemplo:
3.99 significa 3,99% sobre el valor de la transacción. Usa 0 cuando no hay componente porcentual.Parte fija en centavos (entero). Ejemplo:
350 significa R$ 3,50. Usa 0 cuando no hay componente fijo.percentage: 3.99 y fixed: 0 cobra solo el 3,99% del valor. Una tarifa de boleto con percentage: 0 y fixed: 350 cobra R$ 3,50 fijos por boleto, independientemente del valor.
Tarifas resueltas por cuenta
La tabla devuelta por la API entrega el valor efectivo ya resuelto para tu cuenta. Consultas la tarifa final que se aplica a tus transacciones, sin necesidad de saber de dónde proviene ni de combinar reglas.- Cuando una tarifa específica no está configurada, retorna
0(porcentaje y fijo). - La tarifa es por moneda (ISO 4217:
BRL,USD…). Sin el parámetrocurrency, la API utiliza la moneda predeterminada de tu cuenta.
La tarifa de plataforma en el split
Cuando usas Split para dividir el valor de una transacción entre beneficiarios, es posible inyectar una tarifa de plataforma como un elemento del split. En el payload de configuración del split, cada elemento tiene un campotype:
Tipo del elemento de split. Valores posibles:
sale (venta — predeterminado), interest (intereses) y platform_fee (tarifa de plataforma).type: "platform_fee" representa la parte que va a la cuenta de la plataforma, separada de las partes de venta de los beneficiarios. Esto es lo que permite a la plataforma retener su margen sobre cada transacción dividida.
Las tarifas del endpoint
GET /fees son las tarifas del PSP sobre tu cuenta (Pix, boleto, tarjeta, retiro, reembolso, chargeback). La platform_fee del split es una división que tú defines dentro de una transacción. Son conceptos distintos — no los confundas. La mecánica completa de división, incluidas las reglas de processingFee y liable, está en Split.Endpoints
| Método | Ruta | Descripción |
|---|---|---|
GET | /fees | Devuelve la tabla de tarifas resuelta de tu cuenta |
Consultar la tabla de tarifas
GET /fees
Devuelve las tarifas resueltas de tu cuenta: Pix, boleto, tarjeta de 1x a 12x, retiro, reembolso y chargeback (tarifa + multa). Cada tarifa incluye percentage y fixed (centavos).
La autenticación utiliza el header x-api-key (consulta Autenticación).
Parámetros de query
Código de moneda en ISO 4217, con exactamente 3 letras (ej.:
BRL, USD). Se convierte a mayúsculas automáticamente. Opcional — sin él, la API utiliza la moneda predeterminada configurada en tu cuenta.Ejemplo de solicitud
Respuesta 200 OK
Los números anteriores son ejemplos. Las tarifas reales de tu cuenta pueden ser diferentes — la respuesta siempre refleja lo que está configurado para tu company.
Campos de la respuesta
Moneda de las tarifas devueltas (ISO 4217). Si no pasaste
currency en la query, corresponde a la moneda predeterminada de la cuenta.Tarifa del método Pix. Objeto con
percentage y fixed.Tarifa del método boleto. Objeto con
percentage y fixed.Array con una entrada por número de cuotas, de 1x a 12x (siempre 12 elementos). Cada entrada tiene
installments (número de cuotas), percentage y fixed.Tarifa de retiro/payout. Objeto con
percentage y fixed.Tarifa de reembolso. Objeto con
percentage y fixed.Tarifas relacionadas con chargeback. Contiene dos sub-objetos:
fee (tarifa de chargeback) y penalty (multa de chargeback), cada uno con percentage y fixed.Errores
El endpoint retorna200 OK en el camino exitoso. Los errores de autenticación (clave inválida o ausente) siguen el formato estándar de la API. Consulta Errores para la lista de códigos de estado y el formato de respuesta.
Ver también
Referencia: Fees
Detalle técnico del endpoint de tarifas en la Core API.
Split
Cómo dividir valores entre beneficiarios e inyectar la tarifa de plataforma.
Visión general de valores
Cómo Z2Pay calcula tarifas, splits y liquidación.
Liquidación
Cuándo y cómo los valores netos llegan a tu billetera.

