Executa payouts
POST/api/payouts
- 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.
Exige autenticação e papel owner ou admin na comunidade do X-CommunityId. `amount` é o valor que a comunidade recebe; a taxa de saque da plataforma é somada a ele, e `amount + transferFee` sai do saldo disponível (FIN-45). Saldo que não cobre os dois responde 400 com a mensagem traduzida mostrando a taxa. A resposta traz, além do saque, `transferFee` e `totalDebited` (strings com duas casas, como `amount`). O extrato registra a taxa numa entrada própria (`PAYOUT_REQUESTED` com `metadata.isTransferFee = true`), devolvida se o saque for cancelado ou falhar. A taxa vigente pode ser consultada antes em `GET .../payouts/balance` ou `GET .../ledger/balance` (`transferFee`, `maxPayoutAmount`).
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
| Name | Type | Description |
|---|---|---|
amountrequired | number | Valor que a comunidade recebe (maior que 0). A taxa de saque é somada a ele. |
Responses
| Status | Description |
|---|---|
201 | Saque criado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/payouts" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"amount":10}'