Atualiza o status de uma compra consultando o provedor
POST/api/checkout/purchases/{purchaseId}/refresh
- Auth
- Jeton requis
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Para a tela de confirmação, quando o webhook do provedor atrasa ou se perde. Se a compra está `PENDING` ou `PROCESSING` (ou `FAILED` há menos de 7 dias: um PIX cancelado pode ser pago mesmo assim), consulta o pedido no provedor (só leitura) e aplica o que ele diz, exatamente como o webhook faria: pago conclui a compra (e abre a assinatura, lança no ledger, manda o e-mail); falhou ou cancelado fecha a compra como `FAILED`; ainda aberto não muda nada. Idempotente: se o webhook chegar depois, nada é feito duas vezes. Só o comprador, na comunidade do `X-CommunityId`; compra de outra pessoa ou de outra comunidade responde 404. O provedor é consultado no máximo uma vez a cada 10 segundos por compra (`outcome = throttled` dentro dessa janela); compra já concluída responde o status sem consultar (`outcome = unchanged`). Limite de 30 requisições por minuto por IP (429). `outcome`: `paid` (o provedor diz pago; a compra foi ou já estava concluída), `failed` (o provedor diz falhou/cancelado), `pending` (pedido ainda aberto), `unchanged` (compra já fechada, provedor não consultado), `throttled` (consultado há pouco), `skipped` (compra sem pedido no provedor). `subscription` é a assinatura aberta pela compra (ou a renovada, numa cobrança de renovação), ou null.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
purchaseIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (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
La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.
Réponses
| Statut | Description |
|---|---|
200 | Status atual da compra, depois da consulta ao provedor. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
429 | Requisições demais em pouco tempo. |
500 | Erro interno do servidor. |
502 | Provedor de pagamento indisponível; nada foi alterado. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/checkout/purchases/<purchaseId>/refresh" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'