Aller au contenu

Reembolsa uma compra, escolhendo se o acesso continua

POST/api/manage/purchases/{purchaseId}/refunds

Auth
Jeton requis
Clé d’API:
Clé d’API non acceptée
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

**Mexe em dinheiro e manda e-mail ao comprador.** Owner, admin, finance ou SuperAdmin (este age pelo `X-CommunityId`); moderator e member: 403. Compra de outra comunidade: 404.

- **Valor:** `amount` (padrão: o que ainda não foi reembolsado); acima disso, 400. - **Acesso:** `access = KEEP` mantém a compra ativa (só soma o reembolso); `access = REVOKE` remove o acesso (a compra vai a `REFUNDED`) e, numa assinatura, **cancela a assinatura na hora**, qualquer que seja o período reembolsado. - **Cartão e PIX:** a Memberfy devolve pelo provedor, **total ou parcial**, e num pedido com plano e adicionais **cada compra é reembolsada sozinha**: o valor vai ao provedor (`DELETE /charges/{id}` com o valor; sem valor quando é o restante inteiro da cobrança), que divide o estorno na proporção do split (teste T4). O parcial costuma voltar `PENDING` ("processing") e é confirmado pelo webhook `charge.partial_canceled`. A taxa da plataforma volta na mesma proporção do reembolso, e o extrato debita só a parte da comunidade. Sem saldo na conta de recebimento da comunidade, o reembolso fica `AWAITING_BALANCE` (pendente) e sai sozinho, em ordem de chegada, quando entrar saldo (uma venda paga, ou o job a cada 10 minutos, que também percebe as liberações); o acesso escolhido já se aplica, o comprador recebe o e-mail quando o estorno sai, e a parte da comunidade fica reservada: o saque desconta os pendentes (`pendingRefunds` em `GET /api/payouts/balance`). Sem resposta do provedor, o reembolso fica `PENDING`; a conciliação lê a cobrança antes de reenviar e, depois de 3 tentativas sem desfecho, o deixa para o SuperAdmin (`NEEDS_REVIEW`, motivo `unknown_outcome`). Recusa do provedor: 422, com o motivo, e o registro fica `DECLINED`. - **Boleto:** a Memberfy não devolve boleto pago. A comunidade devolve direto ao comprador (PIX ou transferência) e registra aqui com `settledOutside` (data e observação); sem ele, 400 com a orientação. O extrato registra sem valor e a taxa não volta. `settledOutside` em cartão ou PIX: 400. - **Ingressos de um pedido de grupo:** `ticketIds` com os ingressos escolhidos (de `GET /api/manage/purchases/{purchaseId}/tickets`) reembolsa só esses, cada um pelo preço do pedido dividido pelos ingressos (o último leva o que sobrou); sem `amount` (os dois juntos: 400). O percentual da taxa da plataforma volta na proporção e a **parte fixa só volta com o último ingresso** do pedido. Com `access = REVOKE`, só esses ingressos saem (a vaga volta ao tipo, oferecida antes à lista de espera dele; o QR para de valer); o pedido continua até o último. Ingresso que não é do pedido: 404; já reembolsado: 409; pedido de um ingresso só: 400. - **Idempotência:** `idempotencyKey`, gerada pelo app ao abrir o diálogo e reenviada nas repetições: a mesma chave devolve o mesmo reembolso (200), nunca um segundo. A chave já usada em outra compra: 409.

201 com o reembolso (`SUCCEEDED`, `PENDING` ou `AWAITING_BALANCE`); 200 numa repetição. `requestedByMemberId` é o membro de quem pediu.

Paramètres

NomEmplacementTypeDescription
purchaseIdobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

NomTypeDescription
amountfacultatifstringPadrão: o total restante da compra. No máximo 2 casas decimais, sem notação científica, maior que zero e até o restante (senão 400). Vale para boleto, cartão e PIX
accessobligatoireKEEP | REVOKE
reasonfacultatifstringmax 500
idempotencyKeyobligatoirestringmin 8, max 200
ticketIdsfacultatifstring (uuid)[]Os ingressos do pedido de grupo a reembolsar (sem `amount`)
settledOutsidefacultatifobjectSó boleto: já devolvi diretamente ao comprador
settledOutside.atfacultatifstring (date-time)Quando foi devolvido (padrão: agora)
settledOutside.notefacultatifstringmax 500

Réponses

StatutDescription
200Repetição com a mesma chave; o mesmo reembolso.
201Reembolso registrado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Compra que não pode ser reembolsada (pendente, em disputa), nada a reembolsar, provedor que ainda não reembolsa pela API (`refunds.providerOff`), ou chave já usada em outra compra.
422O provedor recusou o reembolso; o motivo vem traduzido e o registro fica DECLINED.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/manage/purchases/<purchaseId>/refunds" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"access":"KEEP","idempotencyKey":"string"}'