Zum Inhalt springen

Cria ou executa payout settings

POST/api/payout-settings

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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

Header

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

Request-Body application/json

NameTypBeschreibung
bankCodePflichtstringCódigo do banco é obrigatório.
accountNumberPflichtstringNúmero da conta é obrigatório.
accountDigitPflichtstringDígito da conta é obrigatório.
branchNumberPflichtstringNúmero da agência é obrigatório.
accountTypePflichtchecking | savings | checking_joint | savings_jointTipo da conta é obrigatório.
holderNamePflichtstringNome do titular é obrigatório.
holderDocumentNumberPflichtstringDocumento do titular é obrigatório.
transferEnabledoptionalbooleantransferEnabled deve ser boolean.
transferIntervaloptionaldaily | weekly | monthlyIntervalo de transferência inválido.
transferDayoptionalintegerDia de transferência deve estar entre 0 e 31.
automaticAnticipationEnabledoptionalbooleanautomaticAnticipationEnabled deve ser boolean.
anticipatableVolumePercentageoptionalintegerPorcentagem deve estar entre 0 e 100.

Antworten

StatusBeschreibung
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.

curl-Beispiel

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