Executa :id cancel
POST/api/payouts/{id}/cancel
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Cancela um saque PENDING. Exige autenticação e papel owner ou admin na comunidade do X-CommunityId. O saque é buscado só dentro dessa comunidade: o id de um saque de outra comunidade responde 404 e nada é alterado (SEC-13). Saque fora de PENDING responde 400.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
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 |
|---|---|
200 | Saque cancelado; o valor volta ao saldo disponível. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/payouts/<id>/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'