Saltar para o conteúdo
memberfy
pt-pt

Cria ou executa payout settings

POST/api/payout-settings

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Sujeito a verificação de papel (RBAC).

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição application/json

NomeTipoDescrição
bankCodeobrigatóriostringCódigo do banco é obrigatório.
accountNumberobrigatóriostringNúmero da conta é obrigatório.
accountDigitobrigatóriostringDígito da conta é obrigatório.
branchNumberobrigatóriostringNúmero da agência é obrigatório.
accountTypeobrigatóriochecking | savings | checking_joint | savings_jointTipo da conta é obrigatório.
holderNameobrigatóriostringNome do titular é obrigatório.
holderDocumentNumberobrigatóriostringDocumento do titular é obrigatório.
transferEnabledopcionalbooleantransferEnabled deve ser boolean.
transferIntervalopcionaldaily | weekly | monthlyIntervalo de transferência inválido.
transferDayopcionalintegerDia de transferência deve estar entre 0 e 31.
automaticAnticipationEnabledopcionalbooleanautomaticAnticipationEnabled deve ser boolean.
anticipatableVolumePercentageopcionalintegerPorcentagem deve estar entre 0 e 100.

Respostas

CódigoDescrição
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com 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"}'