Cria ou executa cancel
POST/api/checkout/{purchaseId}/cancel
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
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ó.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
purchaseIdrequired | path | string |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.
Responses
| Status | Description |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
curl example
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 '{}'