> ## 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 pagos e reembolsados

> Devolve as duas séries que alimentam o gráfico principal do painel: cada venda aprovada no período e cada venda reembolsada no período, com valor bruto, líquido e carimbos de tempo. Use para desenhar a curva do mês ou para conferir um dia específico. Sem período, considera o mês corrente.



## OpenAPI

````yaml /openapi.yaml get /v1/dashboard/paid-and-refunded
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/dashboard/paid-and-refunded:
    get:
      tags:
        - Crescimento
      summary: Consultar pagos e reembolsados
      description: >-
        Devolve as duas séries que alimentam o gráfico principal do painel: cada
        venda aprovada no período e cada venda reembolsada no período, com valor
        bruto, líquido e carimbos de tempo. Use para desenhar a curva do mês ou
        para conferir um dia específico. Sem período, considera o mês corrente.
      operationId: getPaidAndRefundedSummary
      parameters:
        - schema:
            type: string
            format: date-time
          in: query
          name: from
          required: false
          description: >-
            Início do período, em ISO 8601. Sem `from` e `to`, o painel
            considera o mês corrente.
        - schema:
            type: string
            format: date-time
          in: query
          name: to
          required: false
          description: Fim do período, em ISO 8601.
      responses:
        '200':
          description: Séries de vendas pagas e reembolsadas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      paid:
                        type: array
                        items:
                          type: object
                          properties:
                            amount:
                              type: integer
                              description: Valor bruto da venda, em centavos.
                            netAmount:
                              type: integer
                              description: Valor líquido da venda, em centavos.
                            createdAt:
                              type: string
                              format: date-time
                              description: Momento em que a transação foi criada.
                            approvedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento da aprovação.
                            refundedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento do reembolso, quando houve.
                          required:
                            - amount
                            - netAmount
                            - createdAt
                            - approvedAt
                            - refundedAt
                          additionalProperties: false
                        description: Vendas aprovadas no período, em ordem de aprovação.
                      refunded:
                        type: array
                        items:
                          type: object
                          properties:
                            amount:
                              type: integer
                              description: Valor bruto da venda, em centavos.
                            netAmount:
                              type: integer
                              description: Valor líquido da venda, em centavos.
                            createdAt:
                              type: string
                              format: date-time
                              description: Momento em que a transação foi criada.
                            approvedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento da aprovação.
                            refundedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento do reembolso, quando houve.
                          required:
                            - amount
                            - netAmount
                            - createdAt
                            - approvedAt
                            - refundedAt
                          additionalProperties: false
                        description: Vendas reembolsadas no período, em ordem de reembolso.
                    required:
                      - paid
                      - refunded
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Séries de vendas pagas e reembolsadas.
              example:
                success: true
                data:
                  paid:
                    - amount: 49900
                      netAmount: 47405
                      createdAt: '2026-09-11T18:02:11.000Z'
                      approvedAt: '2026-09-11T18:02:47.000Z'
                      refundedAt: null
                  refunded:
                    - amount: 49900
                      netAmount: 47405
                      createdAt: '2026-09-02T10:14:00.000Z'
                      approvedAt: '2026-09-02T10:14:38.000Z'
                      refundedAt: '2026-09-06T09:21:05.000Z'
        '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

````