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

# Obter Taxas do Gateway

> Aprenda a consultar as taxas configuradas do gateway de pagamento da loja usando o endpoint GET /stores/{storeId}/fees.

## 💰 Obter Taxas do Gateway

`GET /stores/{storeId}/fees`

Retorna as **formas de pagamento e as taxas das gateways ativas** da loja.

> **Importante:** as taxas retornadas aqui são as **definidas pelo lojista** no dashboard (seção "Taxas por método" de cada gateway), ou seja, o percentual/valor fixo que ele decide **repassar ao cliente** no checkout. Elas **não** representam o custo que a gateway cobra do lojista — esse custo é interno e fica apenas no frontend do dashboard (tabela `GATEWAY_FEES`), usado para calcular o valor líquido que o lojista recebe.

***

## 🔐 Autenticação

* **Rota pública**.
* A loja vinculada precisa ter plano ativo.

***

## 🧾 Parâmetros de rota

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `storeId` | string | Sim | ID da loja |

***

## ✅ Exemplo de requisição

```bash theme={null}
curl -X GET "https://api.cabrapi.com.br/v1/stores/STORE_ID/fees"
```

***

## 📦 Resposta de sucesso (200)

```json theme={null}
{
  "gateways": [
    {
      "type": "MERCADOPAGO",
      "publicKey": "APP_USR-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "methods": ["pix", "card", "boleto", "saldo"],
      "maxInstallments": 12,
      "installmentFees": [
        { "min": 1, "max": 1, "percent": 0, "fixed": 0 },
        { "min": 2, "max": 6, "percent": 3.49, "fixed": 0.49 },
        { "min": 7, "max": 12, "percent": 3.99, "fixed": 0.49 }
      ],
      "fees": {
        "pix": { "percent": 0, "fixed": 0 },
        "card": { "percent": 4.99, "fixed": 0 }
      }
    },
    {
      "type": "ASAAS",
      "methods": ["pix", "card", "boleto"],
      "maxInstallments": 1,
      "installmentFees": [],
      "fees": {
        "pix": { "percent": 0, "fixed": 1.99 },
        "card": { "percent": 2.99, "fixed": 0.49 }
      }
    },
    {
      "type": "STRIPE",
      "publicKey": "pk_live_xxxxxxxxxxxxxxxxxxxxxxxx",
      "methods": ["pix", "card", "boleto"],
      "maxInstallments": 1,
      "installmentFees": [],
      "fees": {
        "card": { "percent": 3.99, "fixed": 0.39 }
      }
    },
    {
      "type": "EFI_BANK",
      "payeeCode": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "methods": ["pix", "card", "boleto"],
      "maxInstallments": 1,
      "installmentFees": [],
      "fees": {
        "pix": { "percent": 0, "fixed": 0 }
      }
    }
  ],
  "fees": {
    "pix": { "percent": 0, "fixed": 0 },
    "card": { "percent": 4.99, "fixed": 0 }
  }
}
```

* `gateways[]` → **todas** as gateways ativas do dono da loja (`type` entre `MERCADOPAGO`, `ASAAS`, `EFI_BANK` e `STRIPE`, métodos disponíveis `methods[]`, `maxInstallments`, `installmentFees[]`, `fees` por método com `percent` + `fixed`, além de `publicKey` opcional/nullable quando configurada e `payeeCode` opcional/nullable para `EFI_BANK` quando configurado).
* `fees` (top-level) → taxas do **primeiro** gateway ativo, mantido para compatibilidade com consumidores antigos.
* Os valores de `fees` (ex.: Mercado Pago `card` 4,99%, Asaas `pix` R\$ 1,99 / `card` 2,99% + R\$ 0,49) são **configurados pelo lojista** e podem variar de loja para loja — **não** são valores fixos garantidos nem o custo real da gateway.

Quando a loja não possui um gateway ativo (ou não tem credenciais configuradas), as taxas retornam vazias:

```json theme={null}
{
  "gateways": [],
  "fees": {}
}
```

***

## ⚠️ Possíveis erros

* `403 NO_ACTIVE_SUBSCRIPTION` → a loja vinculada está sem plano ativo
* `404 STORE_NOT_FOUND` → loja não encontrada
* `429 RATE_LIMIT_EXCEEDED` → limite de requisições por minuto excedido
* `500 INTERNAL_SERVER_ERROR` → erro interno
* `503 SERVICE_UNAVAILABLE` → serviço temporariamente indisponível

***

## 📝 Observações

* `gateways[]` reflete **todas** as gateways marcadas como **ativas** do dono da loja (`MERCADOPAGO`, `ASAAS`, `EFI_BANK`, `STRIPE`).
* `publicKey` é retornado no objeto da gateway quando presente nas credenciais configuradas (ex.: Mercado Pago ou Stripe); para `EFI_BANK`, `payeeCode` também é retornado quando configurado.
* `methods[]` vem de `credentials.paymentMethods` de cada gateway (fallback: padrão do tipo — `MERCADOPAGO`: `pix/card/boleto/saldo`; `ASAAS`, `EFI_BANK` e `STRIPE`: `pix/card/boleto`).
* `maxInstallments` → número máximo de parcelas no cartão configurado pelo lojista (padrão `1`, máximo `12`).
* `installmentFees` → lista de **faixas de parcelas** configuradas pelo lojista, com taxa própria por intervalo `{ min, max, percent, fixed }` (máximo **12 faixas**, sem sobreposição). Quando a faixa do `installmentCount` existe, checkout e cobrança a usam no lugar da taxa plana `fees.card` — garantindo que o valor exibido ao cliente bate com o cobrado.
* Taxas são lidas das credenciais descriptografadas (AES-256-GCM) do gateway.
* O checkout público usa esta rota para exibir as formas de pagamento reais da loja (ex.: Mercado Pago + Asaas), as parcelas disponíveis (`maxInstallments`) e calcular o repasse de taxa por método/faixa.


## OpenAPI

````yaml GET /stores/{storeId}/fees
openapi: 3.1.0
info:
  title: caBRAPI
  version: 1.0.0
servers:
  - url: https://api.cabrapi.com.br/v1
security: []
paths:
  /stores/{storeId}/fees:
    get:
      tags:
        - Stores
      summary: Get store fees
      operationId: getStoreFees
      parameters:
        - $ref: '#/components/parameters/StoreId'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  fees:
                    type: object
                  gateways:
                    items:
                      properties:
                        fees:
                          type: object
                        installmentFees:
                          items:
                            type: object
                          type: array
                        maxInstallments:
                          type: number
                        methods:
                          items:
                            type: string
                          type: array
                        type:
                          enum:
                            - MERCADOPAGO
                            - ASAAS
                            - EFI_BANK
                            - STRIPE
                          type: string
                        publicKey:
                          type: string
                        payeeCode:
                          type: string
                      required:
                        - type
                        - methods
                      type: object
                    type: array
                required:
                  - gateways
                  - fees
                type: object
          description: Active gateways and store fees.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: NO_ACTIVE_SUBSCRIPTION
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: STORE_NOT_FOUND
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit exceeded.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Service unavailable.
      security: []
components:
  parameters:
    StoreId:
      in: path
      name: storeId
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
  schemas:
    Error:
      properties:
        code:
          example: STORE_NOT_FOUND
          type: string
      required:
        - code
      type: object

````

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