Vai al contenuto

Cria ou executa cancel

POST/api/checkout/{purchaseId}/cancel

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

Fecha como `FAILED` uma compra `PENDING` ou `PROCESSING` que não foi paga. Para `PROCESSING`, consulta o pedido no provedor antes: pago responde 409; cobranças abertas são canceladas no provedor quando ele permite (PIX aguardando pagamento não é cancelável e expira sozinho; um pagamento que ainda chegue é reconhecido pelo webhook). Provedor fora do ar responde 502 sem alterar nada. F-37: cancelar a compra do plano de um pedido com adicionais fecha também as compras dos adicionais do mesmo pedido. A compra de um adicional dentro do pedido do plano responde 409 (`param = purchaseId`): o pedido é um só.

Parametri

NomeDoveTipoDescrizione
purchaseIdobbligatoriopathstring

Header

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

Corpo della richiesta application/json

La specifica non dichiara i campi di questo corpo (un upload multipart, per esempio). Consulta la guida dell’argomento.

Risposte

CodiceDescrizione
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
404Recurso não encontrado.
500Erro interno do servidor.

Esempio con curl

curl -X POST "https://api.memberfy.net/api/checkout/<purchaseId>/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'