Cria ou executa payout settings
POST/api/payout-settings
- Auth
- Requires a token
- 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.
Sujeito a verificação de papel (RBAC).
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 |
|---|---|---|
bankCoderequired | string | Código do banco é obrigatório. |
accountNumberrequired | string | Número da conta é obrigatório. |
accountDigitrequired | string | Dígito da conta é obrigatório. |
branchNumberrequired | string | Número da agência é obrigatório. |
accountTyperequired | checking | savings | checking_joint | savings_joint | Tipo da conta é obrigatório. |
holderNamerequired | string | Nome do titular é obrigatório. |
holderDocumentNumberrequired | string | Documento do titular é obrigatório. |
transferEnabledoptional | boolean | transferEnabled deve ser boolean. |
transferIntervaloptional | daily | weekly | monthly | Intervalo de transferência inválido. |
transferDayoptional | integer | Dia de transferência deve estar entre 0 e 31. |
automaticAnticipationEnabledoptional | boolean | automaticAnticipationEnabled deve ser boolean. |
anticipatableVolumePercentageoptional | integer | Porcentagem deve estar entre 0 e 100. |
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. |
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/payout-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"bankCode":"string","accountNumber":"string","accountDigit":"string","branchNumber":"string","accountType":"checking","holderName":"string","holderDocumentNumber":"string"}'