Zum Inhalt springen

Cria ou executa cancel

POST/api/checkout/{purchaseId}/cancel

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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ó.

Parameter

NameOrtTypBeschreibung
purchaseIdPflichtpathstring

Header

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

Request-Body application/json

Die Spezifikation deklariert die Felder dieses Bodys nicht (zum Beispiel ein Multipart-Upload). Siehe die Anleitung zum Thema.

Antworten

StatusBeschreibung
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.

curl-Beispiel

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 '{}'