> ## 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 pagamentos > Devolve o desempenho por meio de pagamento da empresa autenticada no período: taxa de aprovação e recusa, volume processado, motivos de recusa classificados e aprovação por bandeira, parcelamento e banco emissor. Use para saber onde a recusa dói mais. ## OpenAPI ````yaml /openapi.yaml get /v1/reports/payment 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/payment: get: tags: - Crescimento summary: Consultar relatório de pagamentos description: >- Devolve o desempenho por meio de pagamento da empresa autenticada no período: taxa de aprovação e recusa, volume processado, motivos de recusa classificados e aprovação por bandeira, parcelamento e banco emissor. Use para saber onde a recusa dói mais. operationId: getPaymentReport 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 pagamentos 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: approvalRate: type: object properties: rate: type: number description: Taxa de aprovação no período, em percentual. goalMet: type: boolean description: Se a taxa alcançou a meta da plataforma. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - goalMet - changeVsPreviousPeriod additionalProperties: false description: Taxa de aprovação. refusalRate: type: object properties: rate: type: number description: Taxa de recusa no período, em percentual. totalRefused: type: number description: Transações recusadas. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - totalRefused - changeVsPreviousPeriod additionalProperties: false description: Taxa de recusa. approvedTransactions: type: object properties: total: type: number description: Transações aprovadas. totalAmount: type: number description: Valor aprovado no período, em centavos. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - total - totalAmount - changeVsPreviousPeriod additionalProperties: false description: Volume aprovado. processedVolume: type: object properties: totalAmount: type: number description: Valor processado no período, em centavos. averageTicket: type: number description: Ticket médio processado, em centavos. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - totalAmount - averageTicket - changeVsPreviousPeriod additionalProperties: false description: Volume processado. refusalReasons: type: object properties: totalRefused: type: number description: Transações recusadas no período. classifiedTotal: type: number description: Quantas recusas foi possível classificar. reasons: type: array items: type: object properties: reason: type: string description: Motivo da recusa em texto legível. code: type: string enum: - INSUFFICIENT_FUNDS - CARD_BLOCKED - INVALID_DATA - TIMEOUT - EXPIRED_CARD - ANTIFRAUD_REJECTED - OTHER description: Código normalizado do motivo. count: type: number description: Recusas com este motivo. percentage: type: number description: Fatia das recusas classificadas. required: - reason - code - count - percentage additionalProperties: false description: Motivos de recusa, do mais frequente para o menos. required: - totalRefused - classifiedTotal - reasons additionalProperties: false description: Por que as transações foram recusadas. approvalByBrand: type: object properties: brands: type: array items: type: object properties: brand: type: string description: Bandeira do cartão. rate: type: number description: >- Taxa de aprovação na bandeira, em percentual. transactions: type: number description: Transações na bandeira. required: - brand - rate - transactions additionalProperties: false description: Aprovação por bandeira. required: - brands additionalProperties: false description: Aprovação por bandeira de cartão. approvalByInstallment: type: object properties: installments: type: array items: type: object properties: installment: type: string description: Quantidade de parcelas. rate: type: number description: >- Taxa de aprovação nesse parcelamento, em percentual. volumePercentage: type: number description: Fatia do volume nesse parcelamento. transactions: type: number description: Transações nesse parcelamento. required: - installment - rate - volumePercentage - transactions additionalProperties: false description: Aprovação por parcelamento. required: - installments additionalProperties: false description: Aprovação por número de parcelas. approvalByIssuer: type: object properties: issuers: type: array items: type: object properties: issuer: type: string description: Banco emissor do cartão. rate: type: number description: Taxa de aprovação no emissor, em percentual. required: - issuer - rate additionalProperties: false description: Aprovação por banco emissor. required: - issuers additionalProperties: false description: Aprovação por banco emissor. approvalEvolution: type: object properties: changeOverPeriod: type: number description: Variação da aprovação do início ao fim do período. points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. rate: type: number description: Taxa de aprovação no dia, em percentual. required: - date - rate additionalProperties: false description: Série diária da aprovação. required: - changeOverPeriod - points additionalProperties: false description: Evolução da aprovação. required: - approvalRate - refusalRate - approvedTransactions - processedVolume - refusalReasons - approvalByBrand - approvalByInstallment - approvalByIssuer - approvalEvolution additionalProperties: false required: - success - data additionalProperties: false description: Relatório de pagamentos do período. example: success: true data: approvalRate: rate: 61.2 goalMet: false changeVsPreviousPeriod: 2.8 refusalRate: rate: 38.8 totalRefused: 88 changeVsPreviousPeriod: -2.8 approvedTransactions: total: 97 totalAmount: 4871200 changeVsPreviousPeriod: 14 processedVolume: totalAmount: 11240300 averageTicket: 50214 changeVsPreviousPeriod: 9.6 refusalReasons: totalRefused: 88 classifiedTotal: 81 reasons: - reason: Saldo ou limite insuficiente code: INSUFFICIENT_FUNDS count: 41 percentage: 50.6 approvalByBrand: brands: - brand: visa rate: 64.1 transactions: 52 approvalByInstallment: installments: - installment: 1x rate: 68.4 volumePercentage: 44.2 transactions: 38 approvalByIssuer: issuers: - issuer: Nubank rate: 71.2 approvalEvolution: changeOverPeriod: 2.8 points: - date: '2026-09-11T00:00:00.000Z' rate: 63.4 '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 ````