> ## 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 relatório de aprovação de cartão > Devolve a aprovação de cartão da empresa autenticada calculada POR CLIENTE, o que neutraliza a retentativa: a aprovação exibida tira do denominador quem só não passou por falta de limite, e a conversão real mantém todo mundo. A janela é interpretada em GMT-3 e a variação compara com a janela anterior de mesmo tamanho. ## OpenAPI ````yaml /openapi.yaml get /v1/reports/card-approval 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/reports/card-approval: get: tags: - Crescimento summary: Consultar relatório de aprovação de cartão description: >- Devolve a aprovação de cartão da empresa autenticada calculada POR CLIENTE, o que neutraliza a retentativa: a aprovação exibida tira do denominador quem só não passou por falta de limite, e a conversão real mantém todo mundo. A janela é interpretada em GMT-3 e a variação compara com a janela anterior de mesmo tamanho. operationId: getCardApprovalReport parameters: - schema: type: string format: date-time in: query name: from required: false description: Início do período, em ISO 8601. Sem período, vale a janela padrão. - schema: type: string format: date-time in: query name: to required: false description: Fim do período, em ISO 8601. responses: '200': description: Relatório de aprovação de cartão do período. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: period: type: object properties: start: type: string description: Início da janela, em ISO 8601. end: type: string description: Fim da janela, em ISO 8601. tz: type: string enum: - America/Sao_Paulo description: Fuso em que a janela é interpretada. required: - start - end - tz additionalProperties: false description: Janela efetivamente usada no cálculo. displayedApprovalPct: type: number description: >- Aprovação exibida: exclui do denominador quem não passou só por falta de limite. realConversionPct: type: number description: >- Conversão real: todo cliente de cartão entra no denominador. totals: type: object properties: customers: type: number description: Clientes distintos que tentaram pagar com cartão. approved: type: number description: Clientes com ao menos uma aprovação. lostLimitOnly: type: number description: Clientes perdidos apenas por falta de limite. required: - customers - approved - lostLimitOnly additionalProperties: false description: Totais da janela, deduplicados por cliente. delta: type: object properties: displayedApprovalPct: type: number nullable: true description: >- Variação em pontos percentuais; `null` sem base comparável na janela anterior. realConversionPct: type: number nullable: true description: >- Variação em pontos percentuais; `null` sem base comparável na janela anterior. required: - displayedApprovalPct - realConversionPct additionalProperties: false description: Comparação com a janela anterior de mesmo tamanho. byMethod: type: array items: type: object properties: key: type: string description: >- Meio (`credit_card`) ou bandeira (`visa`, `mastercard`...) do recorte. displayedApprovalPct: type: number description: Aprovação exibida no recorte, em percentual. realConversionPct: type: number description: Conversão real no recorte, em percentual. customers: type: number description: Clientes distintos no recorte. approved: type: number description: Clientes que tiveram ao menos uma aprovação. lostLimitOnly: type: number description: Clientes perdidos apenas por falta de limite. required: - key - displayedApprovalPct - realConversionPct - customers - approved - lostLimitOnly additionalProperties: false description: Recorte por meio de pagamento. byBrand: type: array items: type: object properties: key: type: string description: >- Meio (`credit_card`) ou bandeira (`visa`, `mastercard`...) do recorte. displayedApprovalPct: type: number description: Aprovação exibida no recorte, em percentual. realConversionPct: type: number description: Conversão real no recorte, em percentual. customers: type: number description: Clientes distintos no recorte. approved: type: number description: Clientes que tiveram ao menos uma aprovação. lostLimitOnly: type: number description: Clientes perdidos apenas por falta de limite. required: - key - displayedApprovalPct - realConversionPct - customers - approved - lostLimitOnly additionalProperties: false description: >- Recorte por bandeira. Os recortes se sobrepõem e não somam aos totais. required: - period - displayedApprovalPct - realConversionPct - totals - delta - byMethod - byBrand additionalProperties: false required: - success - data additionalProperties: false description: Relatório de aprovação de cartão do período. example: success: true data: period: start: '2026-09-01T00:00:00.000Z' end: '2026-09-12T02:59:59.999Z' tz: America/Sao_Paulo displayedApprovalPct: 72.4 realConversionPct: 58.1 totals: customers: 148 approved: 86 lostLimitOnly: 29 delta: displayedApprovalPct: 3.2 realConversionPct: 1.7 byMethod: - key: credit_card displayedApprovalPct: 72.4 realConversionPct: 58.1 customers: 148 approved: 86 lostLimitOnly: 29 byBrand: - key: visa displayedApprovalPct: 75.1 realConversionPct: 61.3 customers: 79 approved: 48 lostLimitOnly: 15 '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 ````