> ## 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 a configuração de reembolso do produto > Devolve se o quiz e a contraoferta de retenção estão ligados para o produto, qual contraoferta o comprador vê e a mídia exibida. Responde 404 quando o produto é de outra empresa. ## OpenAPI ````yaml /openapi.yaml get /v1/products/{productId}/refund-settings 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`. **Um `429` que não é limite de requisições.** Em `POST /v1/card` e `POST /v1/subscriptions`, um `429` com `code: "BUYER_ATTEMPTS_EXCEEDED"` no corpo significa que este comprador, e só ele, está bloqueado para pagar com cartão depois de tentativas recusadas em excesso. Nada foi cobrado. Não pause nem atrase as cobranças de outros compradores por causa dele, e não repita a cobrança deste comprador antes de `blockedUntil` (ISO 8601 UTC, também em `retryAfterSeconds` e no header `retry-after`; os dois campos vêm `null` quando o horário não é conhecido). Pix continua disponível para o mesmo comprador. Diferencie os dois casos sempre pelo `code`, nunca pelo status. **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/products/{productId}/refund-settings: get: tags: - Reembolsos summary: Consultar a configuração de reembolso do produto description: >- Devolve se o quiz e a contraoferta de retenção estão ligados para o produto, qual contraoferta o comprador vê e a mídia exibida. Responde 404 quando o produto é de outra empresa. operationId: getProductRefundSettings parameters: - schema: type: string minLength: 1 in: path name: productId required: true description: Identificador do produto. responses: '200': description: Configuração de reembolso do produto. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: productId: type: string description: Produto dono da configuração. quizEnabled: type: boolean description: O comprador responde o quiz antes de pedir reembolso. retentionEnabled: type: boolean description: >- O comprador vê a contraoferta de retenção antes de confirmar o pedido. retentionMode: type: string enum: - courtesy - whatsapp - none description: >- Contraoferta efetiva: produto de cortesia, conversa no WhatsApp ou nenhuma. retentionCourtesyProductId: type: string nullable: true description: Produto oferecido como cortesia na retenção. retentionCourtesyProductName: type: string nullable: true description: Nome do produto de cortesia, quando disponível. mediaType: type: string enum: - video - banner - carousel nullable: true description: 'Mídia da retenção: vídeo, banner ou carrossel.' mediaAspectRatio: type: string enum: - r16_9 - r4_3 - r1_1 - r4_5 - r9_16 nullable: true description: Proporção da mídia de retenção. mediaVideoUrl: type: string nullable: true description: Link do vídeo de retenção. mediaItems: type: array items: type: object properties: id: type: string description: Identificador da imagem. imageUrl: type: string description: URL pública da imagem. alt: type: string nullable: true description: Texto alternativo da imagem. linkUrl: type: string nullable: true description: Link aberto ao clicar na imagem. required: - id - imageUrl - alt - linkUrl additionalProperties: false description: Imagens do banner ou carrossel, na ordem de exibição. whatsappMessage: type: string nullable: true description: >- Mensagem pré-preenchida da conversa de retenção no WhatsApp. questionCount: type: integer description: Perguntas ativas no quiz. maxQuestions: type: integer description: Máximo de perguntas que o quiz aceita. required: - productId - quizEnabled - retentionEnabled - retentionMode - retentionCourtesyProductId - retentionCourtesyProductName - mediaType - mediaAspectRatio - mediaVideoUrl - mediaItems - whatsappMessage - questionCount - maxQuestions additionalProperties: false required: - success - data additionalProperties: false description: Configuração de reembolso do produto. example: success: true data: productId: clx8a2h4k0001qz0a1b2c3d4e quizEnabled: true retentionEnabled: true retentionMode: whatsapp retentionCourtesyProductId: null retentionCourtesyProductName: null mediaType: video mediaAspectRatio: r16_9 mediaVideoUrl: https://www.youtube.com/watch?v=dQw4w9WgXcQ mediaItems: [] whatsappMessage: >- Oi, {saudacao}! Antes de pedir reembolso do {produto}, fala com a gente. questionCount: 2 maxQuestions: 6 '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 '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. 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: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Recurso não encontrado '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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.