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

# Consultar taxas da conta

> Devolve as taxas negociadas da empresa autenticada por meio de pagamento — Pix, cartão (com a curva de parcelamento), boleto e saque — junto com o prazo de recebimento e a reserva de cada um. Valores fixos vêm em centavos e percentuais em centésimos de por cento (299 = 2,99%).



## OpenAPI

````yaml /openapi.yaml get /v1/fees
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/fees:
    get:
      tags:
        - Financeiro
      summary: Consultar taxas da conta
      description: >-
        Devolve as taxas negociadas da empresa autenticada por meio de pagamento
        — Pix, cartão (com a curva de parcelamento), boleto e saque — junto com
        o prazo de recebimento e a reserva de cada um. Valores fixos vêm em
        centavos e percentuais em centésimos de por cento (299 = 2,99%).
      operationId: getFees
      responses:
        '200':
          description: Taxas e prazos vigentes da empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      pix:
                        type: object
                        properties:
                          receiveDays:
                            type: integer
                            description: Dias entre a venda por Pix e o crédito no saldo.
                          limit:
                            type: integer
                            nullable: true
                            description: >-
                              Teto por venda no Pix, em centavos; `null` quando
                              não há teto.
                          feeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa por venda no Pix, em centavos.
                          feePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual por venda no Pix, em centésimos de
                              % (299 = 2,99%).
                          reserve:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                                description: >-
                                  `true` quando parte de cada venda fica retida
                                  como reserva.
                              days:
                                type: integer
                                description: >-
                                  Dias que a reserva fica retida antes de
                                  liberar.
                              percentage:
                                type: number
                                description: >-
                                  Percentual de cada venda que vai para a
                                  reserva, em pontos percentuais.
                            required:
                              - enabled
                              - days
                              - percentage
                            additionalProperties: false
                        required:
                          - receiveDays
                          - limit
                          - feeFixed
                          - feePercentage
                          - reserve
                        additionalProperties: false
                      card:
                        type: object
                        properties:
                          receiveDays:
                            type: integer
                            description: Dias entre a venda no cartão e o crédito no saldo.
                          limit:
                            type: integer
                            nullable: true
                            description: >-
                              Teto por venda no cartão, em centavos; `null`
                              quando não há teto.
                          feeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa por venda no cartão, em centavos.
                          feePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual à vista no cartão, em centésimos
                              de % (499 = 4,99%).
                          reserve:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                                description: >-
                                  `true` quando parte de cada venda fica retida
                                  como reserva.
                              days:
                                type: integer
                                description: >-
                                  Dias que a reserva fica retida antes de
                                  liberar.
                              percentage:
                                type: number
                                description: >-
                                  Percentual de cada venda que vai para a
                                  reserva, em pontos percentuais.
                            required:
                              - enabled
                              - days
                              - percentage
                            additionalProperties: false
                          installmentFees:
                            type: array
                            items:
                              type: object
                              properties:
                                installmentNumber:
                                  type: integer
                                  description: >-
                                    Número de parcelas a que esta taxa se
                                    aplica.
                                fee:
                                  type: integer
                                  description: >-
                                    Percentual cobrado nesse número de parcelas,
                                    em centésimos de % (1290 = 12,90%).
                                cardBrand:
                                  type: string
                                  enum:
                                    - AMERICAN_EXPRESS
                                    - DINERS_CLUB
                                    - DISCOVER
                                    - ELO
                                    - HIPERCARD
                                    - HIPER
                                    - JCB
                                    - MAESTRO
                                    - MASTERCARD
                                    - MIR
                                    - UNIONPAY
                                    - VISA
                                  nullable: true
                                  description: >-
                                    Bandeira a que a linha se aplica; `null`
                                    vale para todas.
                              required:
                                - installmentNumber
                                - fee
                                - cardBrand
                              additionalProperties: false
                            description: Curva de taxas por número de parcelas.
                        required:
                          - receiveDays
                          - limit
                          - feeFixed
                          - feePercentage
                          - reserve
                          - installmentFees
                        additionalProperties: false
                      boleto:
                        type: object
                        properties:
                          receiveDays:
                            type: integer
                            description: >-
                              Dias entre a compensação do boleto e o crédito no
                              saldo.
                          limit:
                            type: integer
                            nullable: true
                            description: >-
                              Teto por boleto, em centavos; `null` quando não há
                              teto.
                          feeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa por boleto pago, em centavos.
                          feePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual por boleto pago, em centésimos de
                              % (150 = 1,50%).
                        required:
                          - receiveDays
                          - limit
                          - feeFixed
                          - feePercentage
                        additionalProperties: false
                      withdrawal:
                        type: object
                        properties:
                          feeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa por saque, em centavos.
                          feePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual por saque, em centésimos de % (150
                              = 1,50%).
                        required:
                          - feeFixed
                          - feePercentage
                        additionalProperties: false
                      highTicket:
                        type: object
                        properties:
                          thresholdCents:
                            type: integer
                            description: >-
                              Valor de venda, em centavos, a partir do qual a
                              faixa vale.
                          cardFeeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa de cartão na faixa, em centavos.
                          cardFeePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual de cartão na faixa, em centésimos
                              de %.
                          pixFeeFixed:
                            type: number
                            nullable: true
                            description: Taxa fixa de Pix na faixa, em centavos.
                          pixFeePercentage:
                            type: integer
                            nullable: true
                            description: >-
                              Taxa percentual de Pix na faixa, em centésimos de
                              %.
                          installmentFees:
                            type: array
                            items:
                              type: object
                              properties:
                                installmentNumber:
                                  type: integer
                                  description: >-
                                    Número de parcelas a que esta taxa se
                                    aplica.
                                fee:
                                  type: integer
                                  description: >-
                                    Percentual da parcela dentro da faixa, em
                                    centésimos de % (1290 = 12,90%).
                              required:
                                - installmentNumber
                                - fee
                              additionalProperties: false
                        required:
                          - thresholdCents
                          - cardFeeFixed
                          - cardFeePercentage
                          - pixFeeFixed
                          - pixFeePercentage
                          - installmentFees
                        additionalProperties: false
                        nullable: true
                        description: >-
                          Faixa de alto valor, quando ativa na conta; `null` se
                          não há.
                    required:
                      - pix
                      - card
                      - boleto
                      - withdrawal
                      - highTicket
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Taxas e prazos vigentes da empresa.
              example:
                success: true
                data:
                  pix:
                    receiveDays: 1
                    limit: null
                    feeFixed: 99
                    feePercentage: 299
                    reserve:
                      enabled: true
                      days: 30
                      percentage: 5
                  card:
                    receiveDays: 15
                    limit: 500000
                    feeFixed: 99
                    feePercentage: 499
                    reserve:
                      enabled: true
                      days: 30
                      percentage: 5
                    installmentFees:
                      - installmentNumber: 1
                        fee: 499
                        cardBrand: null
                      - installmentNumber: 12
                        fee: 1290
                        cardBrand: null
                  boleto:
                    receiveDays: 2
                    limit: null
                    feeFixed: 299
                    feePercentage: 150
                  withdrawal:
                    feeFixed: 350
                    feePercentage: 0
                  highTicket: null
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````