Cria ou executa payout settings
POST/api/payout-settings
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Sujeito a verificação de papel (RBAC).
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
bankCodeobbligatorio | string | Código do banco é obrigatório. |
accountNumberobbligatorio | string | Número da conta é obrigatório. |
accountDigitobbligatorio | string | Dígito da conta é obrigatório. |
branchNumberobbligatorio | string | Número da agência é obrigatório. |
accountTypeobbligatorio | checking | savings | checking_joint | savings_joint | Tipo da conta é obrigatório. |
holderNameobbligatorio | string | Nome do titular é obrigatório. |
holderDocumentNumberobbligatorio | string | Documento do titular é obrigatório. |
transferEnabledfacoltativo | boolean | transferEnabled deve ser boolean. |
transferIntervalfacoltativo | daily | weekly | monthly | Intervalo de transferência inválido. |
transferDayfacoltativo | integer | Dia de transferência deve estar entre 0 e 31. |
automaticAnticipationEnabledfacoltativo | boolean | automaticAnticipationEnabled deve ser boolean. |
anticipatableVolumePercentagefacoltativo | integer | Porcentagem deve estar entre 0 e 100. |
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio con curl
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"}'