Cria ou executa cancel
POST/api/checkout/{purchaseId}/cancel
- 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.
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. 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ó.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
purchaseIdobligatoire | path | string |
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 |
|---|---|
201 | Operação realizada com sucesso. |
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`). |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple 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 '{}'