Tabela de taxas da conta

curl --request GET \
  --url https://api.sandbox.z2pay.com/v1/fees \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.z2pay.com/v1/fees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "currency": "BRL",
  "pix": {
    "percentage": 0.99,
    "fixed": 0
  },
  "boleto": {
    "percentage": 1.99,
    "fixed": 350
  },
  "creditCard": [
    {
      "installments": 1,
      "percentage": 3.99,
      "fixed": 49
    },
    {
      "installments": 2,
      "percentage": 4.49,
      "fixed": 49
    },
    {
      "installments": 3,
      "percentage": 4.99,
      "fixed": 49
    },
    {
      "installments": 4,
      "percentage": 5.49,
      "fixed": 49
    },
    {
      "installments": 5,
      "percentage": 5.99,
      "fixed": 49
    },
    {
      "installments": 6,
      "percentage": 6.49,
      "fixed": 49
    },
    {
      "installments": 7,
      "percentage": 6.99,
      "fixed": 49
    },
    {
      "installments": 8,
      "percentage": 7.49,
      "fixed": 49
    },
    {
      "installments": 9,
      "percentage": 7.99,
      "fixed": 49
    },
    {
      "installments": 10,
      "percentage": 8.49,
      "fixed": 49
    },
    {
      "installments": 11,
      "percentage": 8.99,
      "fixed": 49
    },
    {
      "installments": 12,
      "percentage": 9.49,
      "fixed": 49
    }
  ],
  "withdrawal": {
    "percentage": 0,
    "fixed": 367
  },
  "refund": {
    "percentage": 0,
    "fixed": 0
  },
  "chargeback": {
    "fee": {
      "percentage": 0,
      "fixed": 1500
    },
    "penalty": {
      "percentage": 0,
      "fixed": 0
    }
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "issues": [
      {
        "path": "status",
        "message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
      },
      {
        "path": "startDate",
        "message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
      }
    ]
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

GET

fees

Tabela de taxas da conta

curl --request GET \
  --url https://api.sandbox.z2pay.com/v1/fees \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.z2pay.com/v1/fees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "currency": "BRL",
  "pix": {
    "percentage": 0.99,
    "fixed": 0
  },
  "boleto": {
    "percentage": 1.99,
    "fixed": 350
  },
  "creditCard": [
    {
      "installments": 1,
      "percentage": 3.99,
      "fixed": 49
    },
    {
      "installments": 2,
      "percentage": 4.49,
      "fixed": 49
    },
    {
      "installments": 3,
      "percentage": 4.99,
      "fixed": 49
    },
    {
      "installments": 4,
      "percentage": 5.49,
      "fixed": 49
    },
    {
      "installments": 5,
      "percentage": 5.99,
      "fixed": 49
    },
    {
      "installments": 6,
      "percentage": 6.49,
      "fixed": 49
    },
    {
      "installments": 7,
      "percentage": 6.99,
      "fixed": 49
    },
    {
      "installments": 8,
      "percentage": 7.49,
      "fixed": 49
    },
    {
      "installments": 9,
      "percentage": 7.99,
      "fixed": 49
    },
    {
      "installments": 10,
      "percentage": 8.49,
      "fixed": 49
    },
    {
      "installments": 11,
      "percentage": 8.99,
      "fixed": 49
    },
    {
      "installments": 12,
      "percentage": 9.49,
      "fixed": 49
    }
  ],
  "withdrawal": {
    "percentage": 0,
    "fixed": 367
  },
  "refund": {
    "percentage": 0,
    "fixed": 0
  },
  "chargeback": {
    "fee": {
      "percentage": 0,
      "fixed": 1500
    },
    "penalty": {
      "percentage": 0,
      "fixed": 0
    }
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "issues": [
      {
        "path": "status",
        "message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
      },
      {
        "path": "startDate",
        "message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
      }
    ]
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

GET /fees Faz parte do recurso Fees — como ler cada taxa e o significado de cada campo estão lá. Retorna a tabela de taxas vigente para a sua conta. Não é uma listagem paginada: a resposta é um único objeto, com uma entrada por método de pagamento.

Leia sempre da resposta; nunca chumbe valores no seu código. As taxas são configuradas por conta e negociadas comercialmente — o exemplo abaixo é ilustrativo, não uma tabela oficial. Quando uma taxa não foi configurada, ela resolve para 0 (percentual e fixo), o que é indistinguível de uma taxa realmente zerada.

Exemplo

# Usando a moeda padrão da conta
curl https://api.sandbox.z2pay.com/v1/fees   -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

# Forçando uma moeda específica
curl "https://api.sandbox.z2pay.com/v1/fees?currency=BRL"   -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

{
  "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": 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 }
  }
}

Authorizations

x-api-key

string

header

required

API Key da Credential (gerada no Backoffice)

Query Parameters

currency

enum<string>

Moeda no padrão ISO 4217. Hoje o único valor aceito é 'BRL'. Omitida, usa a moeda padrão da sua conta.

Available options:

BRL

Response

Taxas da conta

Taxas já resolvidas para a sua conta. Taxa não configurada vem com percentage e fixed em 0 — é a resposta desta rota, e não uma tabela publicada, que vale para a sua conta.

currency

string

required

Moeda das taxas (ISO 4217). Sem currency na query, é a moeda padrão da conta.

pix

object

required

Taxa do Pix.

Show child attributes

boleto

object

required

Taxa do boleto.

Show child attributes

creditCard

object[]

required

Taxa de cartão por parcela — sempre 12 entradas, de 1x a 12x.

Show child attributes

withdrawal

object

required

Taxa de saque.

Show child attributes

refund

object

required

Taxa de estorno.

Show child attributes

chargeback

object

required

Taxas relacionadas a chargeback.

Show child attributes

Cobranças

Clientes & Cartões

Checkout

Cobrança recorrente

Split & Recebedores

Webhooks & Eventos

Valores & Taxas

Tabela de taxas da conta

Exemplo

Authorizations

Query Parameters

Response

​Exemplo

Authorizations

Query Parameters

Response

Exemplo