> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeriqpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Simular taxas

> Calcula a taxa efetiva de uma operação

A rota retorna as configurações de taxas e, quando `amount` é informado, uma simulação.

## Autenticação

Todas as rotas exigem o header `X-API-Key`. A chave deve começar com `zeriq_`.

```http theme={null}
X-API-Key: zeriq_sua_chave
```

```bash cURL theme={null}
curl -G "https://api.zeriqpay.com.br/v1/account/fees" \
  -H "X-API-Key: zeriq_sua_chave" \
  --data-urlencode "operation=WITHDRAW" \
  --data-urlencode "amount=100"
```

### Escopo necessário

`transactions.read`

## Referência

* **Método:** `GET`
* **Rota:** `/v1/account/fees`
* **Autenticação:** `X-API-Key`

A referência interativa desta operação é gerada a partir do arquivo OpenAPI da ZeriqPay.

## Guia de integração

1. Envie a requisição para `https://api.zeriqpay.com.br/v1/account/fees` usando o método `GET`.
2. Inclua `X-API-Key` e conceda à chave o escopo `transactions.read`.
3. Trate `success: true` como sucesso e leia o resultado dentro de `data`.
4. Em erros `4xx`, preserve `message` e o status HTTP para diagnóstico e retry controlado.

### Referência rápida

* **Autenticação:** `X-API-Key: zeriq_sua_chave`
* **Content-Type:** `application/json` quando houver body
* **Base URL:** `https://api.zeriqpay.com.br`
* **Contrato:** consulte o bloco OpenAPI interativo desta página para visualizar parâmetros, schemas e exemplos de resposta.


## OpenAPI

````yaml GET /v1/account/fees
openapi: 3.1.0
info:
  title: ZeriqPay API
  description: >-
    Referência da API v1 da ZeriqPay. As rotas de gerenciamento de webhooks não
    fazem parte desta documentação.
  version: 1.0.0
  contact:
    name: ZeriqPay
    url: https://api.zeriqpay.com.br
servers:
  - url: https://api.zeriqpay.com.br
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Conta
    description: Dados, taxas e limites da conta
  - name: Pagamentos PIX
    description: Cobranças PIX
  - name: Transações
    description: Consulta de transações
  - name: Transferências
    description: Saídas PIX, cripto e internas
  - name: Reembolsos
    description: Reembolsos de cobranças
  - name: Disputas MED
    description: Consulta e envio de evidências MED
  - name: Webhooks
    description: Cadastro e configuração dos endpoints de webhook
paths:
  /v1/account/fees:
    get:
      tags:
        - Conta
      summary: Simular taxas
      description: >-
        Calcula a taxa efetiva de depósito ou saque. Sem `amount`, retorna
        apenas a configuração; com `amount`, inclui a simulação.


        **Escopo necessário:** `transactions.read`.
      operationId: getFeeQuote
      parameters:
        - name: operation
          in: query
          required: false
          description: Operação para a cotação.
          schema:
            type: string
            enum:
              - DEPOSIT
              - WITHDRAW
        - name: amount
          in: query
          required: false
          description: Valor da operação em BRL.
          schema:
            type: number
            minimum: 0.01
        - name: providerFee
          in: query
          required: false
          description: Taxa do provedor em BRL; exige amount.
          schema:
            type: number
            minimum: 0
        - name: application
          in: query
          required: false
          description: Como aplicar a taxa.
          schema:
            type: string
            enum:
              - DEDUCT_FROM_GROSS
              - ADD_TO_GROSS
        - name: clampToAmount
          in: query
          required: false
          description: Limita a taxa ao valor informado.
          schema:
            type: boolean
      responses:
        '200':
          description: Operação concluída com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                success: true
                data:
                  currency: BRL
                  deposit:
                    fee:
                      percentage: 0
                      fixed: 0
                  withdraw:
                    fee:
                      percentage: 0
                      fixed: 0
                  simulation: null
        '400':
          description: Dados inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '401':
          description: API Key ausente ou inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '403':
          description: Conta bloqueada ou escopo insuficiente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '429':
          description: Limite específico da rota excedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    GenericResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          additionalProperties: true
      required:
        - success
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key ZeriqPay iniciada por `zeriq_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.